]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/rest-collision.cc
Fix default measure length in beaming-pattern
[lilypond.git] / lily / rest-collision.cc
index 009c7c1e5057af34f8b49ccfd74c95dc3c1263a0..6448492b8f5f925b954fe9fb4064b4b0cb50cb2a 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--1998 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2009 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
-#include "debug.hh"
 #include "rest-collision.hh"
+
+#include <cmath>               // ceil.
+using namespace std;
+
+#include "directional-element-interface.hh"
+#include "duration.hh"
+#include "international.hh"
+#include "item.hh"
 #include "note-column.hh"
+#include "output-def.hh"
+#include "pointer-group-interface.hh"
+#include "rest.hh"
+#include "rhythmic-head.hh"
+#include "staff-symbol-referencer.hh"
 #include "stem.hh"
-#include "note-head.hh"
-#include "collision.hh"
-#include "paper-def.hh"
-
+#include "grob.hh"
+#include "warn.hh"
 
+MAKE_SCHEME_CALLBACK (Rest_collision, force_shift_callback, 1);
+SCM
+Rest_collision::force_shift_callback (SCM smob)
+{
+  Grob *them = unsmob_grob (smob);
+  if (Note_column::has_rests (them))
+    {
+      Grob *collision = unsmob_grob (them->get_object ("rest-collision"));
 
+      if (collision)
+       {
+         (void) collision->get_property ("positioning-done");
+       }
+    }
+  return scm_from_double (0.0);
+}
 
-void
-Rest_collision::add_column (Note_column *nc_l)
+MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Rest_collision, force_shift_callback_rest, 2, 1, "");
+SCM
+Rest_collision::force_shift_callback_rest (SCM rest, SCM offset)
 {
-  add_dependency (nc_l);
-  if (nc_l->rest_b ())
-    rest_l_arr_.push (nc_l);
-  else
-    ncol_l_arr_.push (nc_l);
+  Grob *rest_grob = unsmob_grob (rest);
+  Grob *parent = rest_grob->get_parent (X_AXIS);
+
+  /*
+    translate REST; we need the result of this translation later on,
+    while the offset probably still is 0/calculation-in-progress.
+   */
+  if (scm_is_number (offset))
+    rest_grob->translate_axis (scm_to_double (offset), Y_AXIS);
+  
+  if (Note_column::has_interface (parent))
+    force_shift_callback (parent->self_scm ());
+
+  return scm_from_double (0.0);
 }
 
 void
-Rest_collision::do_post_processing()
+Rest_collision::add_column (Grob *me, Grob *p)
 {
+  Pointer_group_interface::add_grob (me, ly_symbol2scm ("elements"), p);
+
   /*
-    [TODO]
-    handle rest under beam (do_post: beams are calculated now)
-    what about combination of collisions and rest under beam
-   */
+    only add callback for the rests, since we don't move anything
+    else.
+
+    (not?)
+  */
+  add_offset_callback (p, Rest_collision::force_shift_callback_proc, Y_AXIS);
+  p->set_object ("rest-collision", me->self_scm ());
+
+  Grob *rest = unsmob_grob (p->get_object ("rest"));
+  if (rest)
+    {
+      chain_offset_callback (rest,
+                            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.
+*/
+MAKE_SCHEME_CALLBACK (Rest_collision, calc_positioning_done, 1);
+SCM
+Rest_collision::calc_positioning_done (SCM smob)
 {
-  /* 
-     handle rest-rest and rest-note collisions
+  Grob *me = unsmob_grob (smob);
 
-     [todo]
-     decide not to print rest if too crowded?
-   */
+  me->set_property ("positioning-done", SCM_BOOL_T);
 
-  // no rests to collide
-  if (!rest_l_arr_.size())
-    return;
+  extract_grob_set (me, "elements", elts);
 
-  // no partners to collide with
-  if (rest_l_arr_.size() + ncol_l_arr_.size () < 2)
-    return;
+  vector<Grob*> rests;
+  vector<Grob*> notes;
 
-  // meisjes met meisjes
-  if (!ncol_l_arr_.size()) 
+  for (vsize i = 0; i < elts.size (); i++)
     {
-      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);       
+      Grob *e = elts[i];
+      if (unsmob_grob (e->get_object ("rest")))
+       rests.push_back (e);
+      else
+       notes.push_back (e);
     }
-  // meisjes met jongetjes
-  else 
+
+  /*
+    handle rest-rest and rest-note collisions
+
+    [todo]
+    * decide not to print rest if too crowded?
+    */
+
+  /*
+    no partners to collide with
+  */
+  if (rests.size () + notes.size () < 2)
+    return SCM_BOOL_T;
+
+  Real staff_space = Staff_symbol_referencer::staff_space (me);
+  /*
+    only rests
+  */
+  if (!notes.size ())
     {
-      // int dir_i = - ncol_l_arr_[0]->dir_;
-      int dir_i = rest_l_arr_[0]->dir_;
-       
-      // minimum move
-      int minpos = 4;
-       
-      // quart rest height
-      // UGH Should get dims from table!
-      int size_i = 6;
-       
-      Real internote_f = paper ()->internote_f ();
-      int sep_i = 3 + size_i / 2;
-      for (int i = 0; i < ncol_l_arr_.size(); i++) 
+
+      /*
+       This is incomplete: in case of an uneven number of rests, the
+       center one should be centered on the staff.
+      */
+      Drul_array<vector<Grob*> > ordered_rests;
+      for (vsize 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_back (rests[i]);
+         else
+           rests[d]->warning (_ ("cannot resolve rest collision: rest direction not set"));
+       }
+
+      Direction d = LEFT;
+      do
+       vector_sort (ordered_rests[d], Note_column::shift_less);
+      while (flip (&d) != LEFT)
+       ;
+
+      do
        {
-         // 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++)
+         if (ordered_rests[d].size () < 1)
            {
-             int stem = (int)((ncol_l_arr_[i]->stem_l_->extent
-                              (Y_AXIS)[dir_i]) / internote_f);
-             minpos = minpos >? (dir_i * stem + sep_i);
+             if (ordered_rests[-d].size () > 1)
+               ordered_rests[-d][0]->warning (_ ("too many colliding rests"));
+
+             return SCM_BOOL_T;
            }
        }
-      rest_l_arr_[0]->translate_rests (dir_i * minpos);        
-    }
-}
+      while (flip (&d) != LEFT);
 
-void
-Rest_collision::do_print() const
-{
-#ifndef NPRINT
-  DOUT << "rests: " << rest_l_arr_.size() << ", ";
-  DOUT << "cols: " << ncol_l_arr_.size();
-#endif
-}
+      Grob *common = common_refpoint_of_array (ordered_rests[DOWN], me, Y_AXIS);
+      common = common_refpoint_of_array (ordered_rests[UP], common, Y_AXIS);
 
-void
-Rest_collision::do_substitute_dependency (Score_element*o,Score_element*n)
-{
-  if (Note_column *onl = dynamic_cast<Note_column *> (o))
+      Real diff
+       = (ordered_rests[DOWN].back ()->extent (common, Y_AXIS)[UP]
+          - ordered_rests[UP].back ()->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].back (),
+                                       -2 * amount_down);
+         if (diff > 0)
+           Note_column::translate_rests (ordered_rests[UP].back (),
+                                         2 * int (ceil (diff)));
+       }
+
+      do
+       {
+         for (vsize 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);
+    }
+  else
     {
-      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);
+      /*
+       Rests and notes.
+      */
+      if (rests.size () > 1)
+       warning (_ ("too many colliding rests"));
+      Grob *rcol = 0;
+      Direction dir = CENTER;
+
+      for (vsize i = rests.size (); !rcol && i--;)
+       if (Note_column::dir (rests[i]))
+         {
+           rcol = rests[i];
+           dir = Note_column::dir (rcol);
+         }
+
+      if (!rcol)
+       return SCM_BOOL_T;
+
+      Grob *rest = Note_column::get_rest (rcol);
+      Grob *common = common_refpoint_of_array (notes, rcol, Y_AXIS);
+
+      Interval restdim = rcol->extent (common, Y_AXIS);
+      if (restdim.is_empty ())
+       return SCM_BOOL_T;
+
+      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 (vsize i = 0; i < notes.size (); i++)
+       {
+         if (Note_column::dir (notes[i]) == -dir
+             // If the note has already happened (but it has a long duration, so there is a collision),
+             // don't look at the stem. If we do, the rest gets shifted down a lot and it looks bad.
+             || dynamic_cast<Item*> (notes[i])->get_column () != dynamic_cast<Item*> (rest)->get_column ())
+           {
+             /* try not to look at the stem, as looking at a beamed
+                note may trigger beam positioning prematurely.
+
+                This happens with dotted rests, which need Y
+                positioning to compute X-positioning.
+             */
+             Grob *head = Note_column::first_head (notes[i]);
+             if (head)
+               notedim.unite (head->extent (common, Y_AXIS));
+             else
+               programming_error ("Note_column without first_head()");
+           }
+         else
+           notedim.unite (notes[i]->extent (common, Y_AXIS));
+       }
+
+      Real y = dir * max (0.0,
+                         -dir * restdim[-dir] + dir * notedim[dir]  + minimum_dist);
+      
+      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_y = dir * int (ceil (y / (0.5 * dir * staff_space)));
+
+      // move by whole spaces inside the staff.
+      if (fabs (Staff_symbol_referencer::get_position (rest)
+               + discrete_y) < stafflines + 1)
+       {
+         discrete_y = dir * int (ceil (dir * discrete_y / 2.0) * 2.0);
+       }
+
+      Note_column::translate_rests (rcol, discrete_y);
     }
+  return SCM_BOOL_T;
 }
 
-Rest_collision::Rest_collision()
-{
-  transparent_b_ = true;
-  set_empty (true);
-}
+ADD_INTERFACE (Rest_collision,
+              "Move around ordinary rests (not multi-measure-rests) to avoid"
+              " conflicts.",
+
+              /* properties */
+              "minimum-distance "
+              "positioning-done "
+              "elements "
+              );
+