]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/rest-collision.cc
new file, move from
[lilypond.git] / lily / rest-collision.cc
index 07ab3c764aa789991245e082ef68dec9d3e24275..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 "beam.hh"
-#include "debug.hh"
+#include "warn.hh"
 #include "rest-collision.hh"
 #include "note-column.hh"
 #include "stem.hh"
-#include "note-head.hh"
-#include "collision.hh"
-#include "paper-def.hh"
+#include "rhythmic-head.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"
 
-void
-Rest_collision::add_column (Note_column *nc_l)
+MAKE_SCHEME_CALLBACK (Rest_collision,force_shift_callback,2);
+SCM
+Rest_collision::force_shift_callback (SCM element_smob, SCM axis)
 {
-  add_dependency (nc_l);
-  Group_interface gi (this);  
-  if (nc_l->rest_b ())
-    gi.name_ = "rests";
-  else
-    gi.name_ = "notes";
+  Grob *them = unsmob_grob (element_smob);
+  Axis a = (Axis) ly_scm2int (axis);
+  assert (a == Y_AXIS);
+
+  Grob * rc = unsmob_grob (them->get_property ("rest-collision"));
+
+  if (rc && !to_boolean (rc->get_property ("positioning-done")))
+    {
+      rc->set_property ("positioning-done", SCM_BOOL_T);
+
+      do_shift (rc);
+    }
   
-  gi.add_element (nc_l);
+  return scm_make_real (0.0);
 }
 
+
+
 void
-Rest_collision::do_pre_processing()
+Rest_collision::add_column (Grob*me,Grob *p)
 {
-  Link_array<Note_column> rest_l_arr =
-    Group_interface__extract_elements (this, (Note_column*) 0, "rests");
-  Link_array<Note_column> ncol_l_arr =
-    Group_interface__extract_elements (this, (Note_column*) 0, "notes");
-                                     
+  me->add_dependency (p);
+  Pointer_group_interface::add_grob (me, ly_symbol2scm ("elements"), p);
+
+  /*
+    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 (Grob * col)
+{
+  Grob * s = unsmob_grob (col->get_property ("rest"));
+
+  if (!s)
+    return SCM_BOOL_F;
+  else
+    return scm_cons (s->get_property ("duration-log"),
+                   scm_int2num (Rhythmic_head::dot_count (s)));
+}
+
+/*
+  TODO: look at horizontal-shift to determine ordering between rests
+  for more than two voices.
+  
+ */
+SCM
+Rest_collision::do_shift (Grob *me)
+{
+  SCM elts = me->get_property ("elements");
+
+  Link_array<Grob> rests;
+  Link_array<Grob> notes;
+
+  for (SCM s = elts; ly_c_pair_p (s); s = ly_cdr (s))
+    {
+      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);
+    }
+
   
   /* 
      handle rest-rest and rest-note collisions
 
      [todo]
      * decide not to print rest if too crowded?
-
-     * ignore rests under beams.
    */
 
-  // no rests to collide
-  if (!rest_l_arr.size())
-    return;
+  /*
+    no partners to collide with
+   */
+  if (rests.size () + notes.size () < 2)
+    return SCM_UNSPECIFIED;
 
-  // no partners to collide with
-  if (rest_l_arr.size() + ncol_l_arr.size () < 2)
-    return;
 
-  // meisjes met meisjes
-  if (!ncol_l_arr.size()) 
+  Real staff_space = Staff_symbol_referencer::staff_space (me);
+  /*
+    only rests
+  */
+  if (!notes.size ()) 
     {
+
       /*
-       UGH.  Should get dims from table.  Should have minimum dist.
+       This is incomplete: in case of an uneven number of rests, the
+       center one should be centered on the staff.
        */
-      int dy = rest_l_arr.size() > 2 ? 6 : 4;
-       
-      rest_l_arr[0]->translate_rests (rest_l_arr[0]->dir () *dy);      
-      rest_l_arr.top()->translate_rests (rest_l_arr.top ()->dir ()* dy);
+      Drul_array< Link_array <Grob > > ordered_rests;
+      for (int i= 0; i < rests.size (); i++)
+       {
+         Grob * r = Note_column::get_rest (rests[i]);
+         
+         Direction d = get_grob_direction (r);
+         if (d)
+           {
+             ordered_rests[d].push (rests[i]);
+           }
+         else
+           rests[d]->warning (_("rest direction not set.  Cannot resolve collision."));
+       }
+
+      Direction d =  LEFT;
+      do {
+       ordered_rests[d].sort (Note_column::shift_compare);
+      } while (flip (&d) != LEFT);
+      
+      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)
+       {
+         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 
     {
-      if (rest_l_arr.size () > 1)
-       {
-         warning (_("too many colliding rests"));
-       }
-      if (ncol_l_arr.size () > 1)
+      /*
+       Rests and notes.
+       */
+      if (rests.size () > 1)
        {
-         warning (_("too many notes for rest collision"));
+         warning (_ ("too many colliding rests"));
        }
-      Note_column * rcol = rest_l_arr[0];
+      Grob * rcol = 0;
+      Direction dir = CENTER;
 
-      // try to be opposite of noteheads. 
-      Direction dir = - ncol_l_arr[0]->dir();
+      for (int i= rests.size (); !rcol && i--;)
+       if (Note_column::dir (rests[i]))
+         {
+           dir = Note_column::dir (rests[i]);
+           rcol = rests[i];
+         }
 
-      Interval restdim = rcol->rest_dim ();
-      if (restdim.empty_b ())
-       return;
+      if (!rcol)
+       return SCM_UNSPECIFIED;
       
-      // staff ref'd?
-      Real staff_space = paper_l()->get_var ("interline");
-
-       /* FIXME
-         staff_space =  rcol->rest_l_arr[0]->staff_space ();
-       */
-      Real half_staff_space_f = staff_space/2;
-      Real minimum_dist = paper_l ()->get_var ("restcollision_minimum_dist")
-       * half_staff_space_f;
+      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 < ncol_l_arr.size(); i++) 
+      for (int i = 0; i < notes.size (); i++) 
        {
-         notedim.unite (ncol_l_arr[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->rest_l_arr[0]->line_count;
-      int stafflines = Staff_symbol_referencer_interface (this).line_count ();
-      // hurg?
-      stafflines = stafflines != 0 ? stafflines : 5;
+      int stafflines = Staff_symbol_referencer::line_count (me);
+      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)));
@@ -127,18 +243,15 @@ Rest_collision::do_pre_processing()
       // move by whole spaces inside the staff.
       if (discrete_dist < stafflines+1)
        discrete_dist = int (ceil (discrete_dist / 2.0)* 2.0);
-      
-      rcol->translate_rests (dir * discrete_dist);
+
+      Note_column::translate_rests (rcol,dir * discrete_dist);
     }
+  return SCM_UNSPECIFIED;
 }
 
 
-Rest_collision::Rest_collision()
-{
-  set_elt_property ("rests", SCM_EOL);
-  set_elt_property ("notes", SCM_EOL);
-  set_elt_property ("transparent", SCM_BOOL_T);
-  set_empty (X_AXIS);
-  set_empty (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");