]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/rest-collision.cc
(process_acknowledged_grobs): don't
[lilypond.git] / lily / rest-collision.cc
index c89d39a73a795302456908b6ebdc72352f3acbe7..ea9dba5010deaf58d060ac1a81998029ac254b72 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--1998 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
 
-#include "debug.hh"
 #include "rest-collision.hh"
+
+#include <math.h>              // ceil.
+
+#include "warn.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"
 
+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);
+  (void) axis;
+  assert (scm_to_int (axis) == Y_AXIS);
 
+  if (Note_column::has_rests (them))
+    {
+      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);
+       }
+    }
+  return scm_make_real (0.0);
+}
 
-void
-Rest_collision::add_column (Note_column *nc_l)
+MAKE_SCHEME_CALLBACK (Rest_collision, force_shift_callback_rest, 2);
+SCM
+Rest_collision::force_shift_callback_rest (SCM rest, SCM axis)
 {
-  add_dependency (nc_l);
-  if (nc_l->rest_b ())
-    rest_l_arr_.push (nc_l);
+  Grob *rest_grob = unsmob_grob (rest);
+  assert ((Axis) scm_to_int (axis) == Y_AXIS);
+
+  Grob *parent = rest_grob->get_parent (X_AXIS);
+  if (Note_column::has_interface (parent))
+    return force_shift_callback (parent->self_scm (), axis);
   else
-    ncol_l_arr_.push (nc_l);
+    return scm_make_real (0.0);
 }
 
 void
-Rest_collision::do_post_processing()
+Rest_collision::add_column (Grob *me, Grob *p)
 {
-  /*
-    handle rest under beam (do_post: beams are calculated now)
+  me->add_dependency (p);
+  Pointer_group_interface::add_grob (me, ly_symbol2scm ("elements"), p);
 
-    [todo]
-    i-d like to have access to the beam itself, 
-    iso only the (half-initialised?) stem
-
-    what about combination of collisions and rest under beam
-   */
-
-  // no rests to collide
-  if (!rest_l_arr_.size())
-       return;
-  // can this happen?
-  Stem* stem_l = rest_l_arr_[0]->stem_l_;
-  if (!stem_l)
-    return;
-  // no beam
-  if (!(stem_l->beams_left_i_ || stem_l->beams_right_i_))
-    return;
-
-  int dir_i = rest_l_arr_[0]->dir_;
-  int midpos = 4;
-  // ugh
-  int stem_length_i = 7 - 2;
-  // ugh, Stem::stem_start vs Stem::stem_end
-  int pos = (int)(stem_l->stem_end_f() - midpos) - dir_i * stem_length_i;
   /*
-    nogo: stem_start not set for rests?
-  int pos = (stem_l->stem_begin_f() - midpos) + dir_i * 2;
+    only add callback for the rests, since we don't move anything
+    else.
 
-  WHY IS THIS STILL HERE? --hwn
+    (not?)
   */
-  rest_l_arr_[0]->translate_rests (pos);       
+  p->add_offset_callback (Rest_collision::force_shift_callback_proc, Y_AXIS);
+  p->set_property ("rest-collision", me->self_scm ());
+
+  Grob *rest = unsmob_grob (p->get_property ("rest"));
+  if (rest)
+    {
+      rest->add_offset_callback (Rest_collision::force_shift_callback_rest_proc,
+                                Y_AXIS);
+    }
 }
 
-void
-Rest_collision::do_pre_processing()
+/*
+  TODO: look at horizontal-shift to determine ordering between rests
+  for more than two voices.
+*/
+SCM
+Rest_collision::do_shift (Grob *me)
 {
-  /* 
-     handle rest-rest and rest-note collisions
+  SCM elts = me->get_property ("elements");
+
+  Link_array<Grob> rests;
+  Link_array<Grob> notes;
 
-     [todo]
-     decide not to print rest if too crowded?
-   */
+  for (SCM s = elts; scm_is_pair (s); s = scm_cdr (s))
+    {
+      Grob *e = unsmob_grob (scm_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);
+    }
 
-  // no rests to collide
-  if (!rest_l_arr_.size())
-    return;
+  /*
+    handle rest-rest and rest-note collisions
+
+    [todo]
+    * decide not to print rest if too crowded?
+    */
 
-  // no partners to collide with
-  if (rest_l_arr_.size() + ncol_l_arr_.size () < 2)
-    return;
+  /*
+    no partners to collide with
+  */
+  if (rests.size () + notes.size () < 2)
+    return SCM_UNSPECIFIED;
 
-  // meisjes met meisjes
-  if (!ncol_l_arr_.size()) 
+  Real staff_space = Staff_symbol_referencer::staff_space (me);
+  /*
+    only rests
+  */
+  if (!notes.size ())
     {
-      int dy = rest_l_arr_.size() > 2 ? 6 : 4;
-       
-      rest_l_arr_[0]->translate_rests (rest_l_arr_[0]->dir_ *dy);      
-      // top is last element...
-      rest_l_arr_.top()->translate_rests (rest_l_arr_.top ()->dir_* dy);       
+
+      /*
+       This is incomplete: in case of an uneven number of rests, the
+       center one should be centered on the staff.
+      */
+      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 (_ ("can't resolve rest collission: rest direction not set"));
+       }
+
+      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 
+  else
     {
-      // int dir_i = - ncol_l_arr_[0]->dir_;
-      int dir_i = rest_l_arr_[0]->dir_;
-      // hope it's 4: if it works->doco
-      int midpos = 0;
-       
-      // minimum move
-      int minpos = 4;
-       
-      // quart rest height
-      // UGH Should get dims from table!
-      int size_i = 6;
-       
-      int sep_i = 3 + size_i / 2;
-      for (int i = 0; i < ncol_l_arr_.size(); i++) 
+      /*
+       Rests and notes.
+      */
+      if (rests.size () > 1)
        {
-         // how to know whether to sort?
-         ncol_l_arr_[i]->sort();
-         for (int j = 0; j < ncol_l_arr_[i]->head_l_arr_.size(); j++)
-           minpos = minpos >? dir_i * 
-             (ncol_l_arr_[i]->head_l_arr_[j]->position_i_ -midpos) + sep_i;
+         warning (_ ("too many colliding rests"));
        }
-      rest_l_arr_[0]->translate_rests (dir_i * minpos);        
-    }
-}
+      Grob *rcol = 0;
+      Direction dir = CENTER;
 
-void
-Rest_collision::do_print() const
-{
-#ifndef NPRINT
-  DOUT << "rests: " << rest_l_arr_.size() << ", ";
-  DOUT << "cols: " << ncol_l_arr_.size();
-#endif
-}
+      for (int i = rests.size (); !rcol && i--;)
+       if (Note_column::dir (rests[i]))
+         {
+           dir = Note_column::dir (rests[i]);
+           rcol = rests[i];
+         }
 
-void
-Rest_collision::do_substitute_dependency (Score_element*o,Score_element*n)
-{
-  if (Note_column *onl = dynamic_cast<Note_column *> (o))
-    {
-      Note_column *n_l = n?dynamic_cast<Note_column *> (n):0;
-      rest_l_arr_.substitute (onl, n_l);
-      ncol_l_arr_.substitute (onl, n_l);
+      if (!rcol)
+       return SCM_UNSPECIFIED;
+
+      Grob *common = common_refpoint_of_array (notes, rcol, Y_AXIS);
+
+      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++)
+       {
+         notedim.unite (notes[i]->extent (common, Y_AXIS));
+       }
+
+      Real dist
+       = minimum_dist + dir * max (notedim[dir] - restdim[-dir], 0.0);
+
+      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)));
+
+      // 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;
 }
 
-Rest_collision::Rest_collision()
-{
-  transparent_b_ = true;
-  set_empty (true);
-}
+ADD_INTERFACE (Rest_collision, "rest-collision-interface",
+              "Move around ordinary rests (not multi-measure-rests) to avoid "
+              "conflicts.",
+              "minimum-distance positioning-done elements");
+