]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/rest-collision.cc
Run `make grand-replace'.
[lilypond.git] / lily / rest-collision.cc
index 6a7eceecaba2586874b35c919319f024559528db..29313f1ccbac720f4d64466c72e0b79eb75c55be 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
-#include <math.h>              // ceil.
-
-#include "warn.hh"
 #include "rest-collision.hh"
+
+#include <cmath>               // ceil.
+using namespace std;
+
+#include "directional-element-interface.hh"
+#include "duration.hh"
+#include "international.hh"
 #include "note-column.hh"
-#include "stem.hh"
-#include "rhythmic-head.hh"
-#include "paper-def.hh"
+#include "output-def.hh"
+#include "pointer-group-interface.hh"
 #include "rest.hh"
-#include "group-interface.hh"
+#include "rhythmic-head.hh"
 #include "staff-symbol-referencer.hh"
-#include "duration.hh"
+#include "stem.hh"
+#include "grob.hh"
+#include "warn.hh"
 
-MAKE_SCHEME_CALLBACK (Rest_collision,force_shift_callback,2);
+MAKE_SCHEME_CALLBACK (Rest_collision, force_shift_callback, 1);
 SCM
-Rest_collision::force_shift_callback (SCM element_smob, SCM axis)
+Rest_collision::force_shift_callback (SCM smob)
 {
-  Grob *them = unsmob_grob (element_smob);
-  Axis a = (Axis) gh_scm2int (axis);
-  assert (a == Y_AXIS);
-
-  Grob * rc = unsmob_grob (them->get_grob_property ("rest-collision"));
-
-  if (rc && !to_boolean (rc->get_grob_property ("positioning-done")))
+  Grob *them = unsmob_grob (smob);
+  if (Note_column::has_rests (them))
     {
-      rc->set_grob_property ("positioning-done", SCM_BOOL_T);
+      Grob *collision = unsmob_grob (them->get_object ("rest-collision"));
 
-      do_shift (rc);
+      if (collision)
+       {
+         (void) collision->get_property ("positioning-done");
+       }
     }
+  return scm_from_double (0.0);
+}
+
+MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Rest_collision, force_shift_callback_rest, 2, 1, "");
+SCM
+Rest_collision::force_shift_callback_rest (SCM rest, SCM offset)
+{
+  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);
   
-  return gh_double2scm (0.0);
+  if (Note_column::has_interface (parent))
+    force_shift_callback (parent->self_scm ());
+
+  return scm_from_double (0.0);
 }
 
 void
-Rest_collision::add_column (Grob*me,Grob *p)
+Rest_collision::add_column (Grob *me, Grob *p)
 {
-  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?)
   (not?)
   */
-  p->add_offset_callback (Rest_collision::force_shift_callback_proc, Y_AXIS);
-  p->set_grob_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_grob_property ("rest"));
+  add_offset_callback (p, Rest_collision::force_shift_callback_proc, Y_AXIS);
+  p->set_object ("rest-collision", me->self_scm ());
 
-  if (!s)
-    return SCM_BOOL_F;
-  else
-    return gh_cons (s->get_grob_property ("duration-log"),
-                   gh_int2scm (Rhythmic_head::dot_count (s)));
+  Grob *rest = unsmob_grob (p->get_object ("rest"));
+  if (rest)
+    {
+      chain_offset_callback (rest,
+                            Rest_collision::force_shift_callback_rest_proc, Y_AXIS);
+    }
 }
 
 /*
-  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.
-
-  TODO: look at previous note to determine vertical position?
-  
- */
+*/
+MAKE_SCHEME_CALLBACK (Rest_collision, calc_positioning_done, 1);
 SCM
-Rest_collision::do_shift (Grob *me)
+Rest_collision::calc_positioning_done (SCM smob)
 {
-  SCM elts = me->get_grob_property ("elements");
+  Grob *me = unsmob_grob (smob);
+
+  me->set_property ("positioning-done", SCM_BOOL_T);
 
-  Link_array<Grob> rests;
-  Link_array<Grob> notes;
+  extract_grob_set (me, "elements", elts);
 
-  for (SCM s = elts; gh_pair_p (s); s = ly_cdr (s))
+  vector<Grob*> rests;
+  vector<Grob*> notes;
+
+  for (vsize i = 0; i < elts.size (); i++)
     {
-      Grob * e = unsmob_grob (ly_car (s));
-      if (unsmob_grob (e->get_grob_property ("rest")))
-       rests.push (e);
+      Grob *e = elts[i];
+      if (unsmob_grob (e->get_object ("rest")))
+       rests.push_back (e);
       else
-       notes.push (e);
+       notes.push_back (e);
     }
 
-  
-  /* 
-     handle rest-rest and rest-note collisions
-
-     [todo]
-     * decide not to print rest if too crowded?
-
-     * ignore rests under beams.
-   */
+  /*
+    handle rest-rest and rest-note collisions
 
-  // no rests to collide
-  if (!rests.size ())
-    return SCM_UNSPECIFIED;
+    [todo]
+    * decide not to print rest if too crowded?
+    */
 
-  // no partners to collide with
+  /*
+    no partners to collide with
+  */
   if (rests.size () + notes.size () < 2)
-    return SCM_UNSPECIFIED;
+    return SCM_BOOL_T;
 
-  // meisjes met meisjes
-  if (!notes.size ()) 
+  Real staff_space = Staff_symbol_referencer::staff_space (me);
+  /*
+    only rests
+  */
+  if (!notes.size ())
     {
-      SCM characteristic = head_characteristic (rests[0]);
-      int i = 1;
-      for (; i < rests.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++)
        {
-         if (!gh_equal_p (head_characteristic (rests[i]), characteristic))
-           break;
+         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"));
        }
 
-      /*
-       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).
-       */
-      int display_count;
-      SCM s = me->get_grob_property ("maximum-rest-count");
-      if (i == rests.size ()
-         && gh_number_p (s) && gh_scm2int (s) < rests.size ())
+      Direction d = LEFT;
+      do
+       vector_sort (ordered_rests[d], Note_column::shift_less);
+      while (flip (&d) != LEFT)
+       ;
+
+      do
        {
-         display_count = gh_scm2int (s);
-         for (; i > display_count; i--)
+         if (ordered_rests[d].size () < 1)
            {
-             Grob* r = unsmob_grob (rests[i-1]->get_grob_property ("rest"));
-             if (r)
-               {
-                 Grob * d = unsmob_grob (r->get_grob_property ("dot"));
-                 if (d)
-                   d->suicide();
-                 r->suicide ();
-               }
-             rests[i-1]->suicide ();
+             if (ordered_rests[-d].size () > 1)
+               ordered_rests[-d][0]->warning (_ ("too many colliding rests"));
+
+             return SCM_BOOL_T;
            }
        }
-      else
-       display_count = rests.size ();
-      
-      /*
-       Ugh. Should have minimum dist.
+      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].back ()->extent (common, Y_AXIS)[UP]
+          - ordered_rests[UP].back ()->extent (common, Y_AXIS)[DOWN]) / staff_space;
 
-       Ugh. What do we do if we have three different rests?
-       
-       */
-      int dy = display_count > 2 ? 6 : 4; // FIXME Should get dims from table.
-      if (display_count > 1)
+      if (diff > 0)
        {
-         Direction d0 = Note_column::dir (rests[0]);
-         Direction d1 = Note_column::dir (rests[1]);     
+         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)));
+       }
 
-         if (!d0 && !d1)
+      do
+       {
+         for (vsize i = ordered_rests[d].size () -1; i-- > 0;)
            {
-             d0= UP;
-             d1 = DOWN;
+             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);
            }
-         else if (!d0)
-           d0 = - d1;
-         else if (!d1)
-           d1 = -d0;
-               
-         Note_column::translate_rests (rests[0],d0 *dy);       
-         Note_column::translate_rests (rests[1], d1 *dy);
        }
+      while (flip (&d) != LEFT);
     }
-  // meisjes met jongetjes
-  else 
+  else
     {
+      /*
+       Rests and notes.
+      */
       if (rests.size () > 1)
-       {
-         warning (_ ("too many colliding rests"));
-       }
-      Grob * rcol = rests[0];
-      Direction dir = Note_column::dir (rests[0]);
+       warning (_ ("too many colliding rests"));
+      Grob *rcol = 0;
+      Direction dir = CENTER;
 
-      if (!dir)
-       {
-         dir = - Note_column::dir (notes[0]);
-       }
-      Grob * r = unsmob_grob (rcol->get_grob_property ("rest"));
-      Interval restdim = r->extent (r, Y_AXIS);        // ??
-
-      if (restdim.is_empty ())
-       return SCM_UNSPECIFIED;
-      
+      for (vsize i = rests.size (); !rcol && i--;)
+       if (Note_column::dir (rests[i]))
+         {
+           rcol = rests[i];
+           dir = Note_column::dir (rcol);
+         }
 
-      Real staff_space = Staff_symbol_referencer::staff_space (rcol);
+      if (!rcol)
+       return SCM_BOOL_T;
 
-      Real minimum_dist = gh_scm2double (me->get_grob_property ("minimum-distance")) * staff_space;
+      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;
 
-      Grob *common = common_refpoint_of_array (notes, rcol, Y_AXIS);
+      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 (vsize i = 0; i < notes.size (); i++)
        {
-         notedim.unite (notes[i]->extent (common, Y_AXIS));
+         if (Note_column::dir (notes[i]) == -dir)
+           {
+             /* 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));
        }
 
-      Interval inter (notedim);
-      inter.intersect (restdim);
-
-      Real dist =
-       minimum_dist +  dir * (notedim[dir] - restdim[-dir]) >? 0;
-
+      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;
+         programming_error ("no staff line count");
+         stafflines = 5;
        }
-      
+
       // move discretely by half spaces.
-      int discrete_dist = int (ceil (dist / (0.5 *staff_space)));
+      int discrete_y = dir * int (ceil (y / (0.5 * dir * 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);
+      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_UNSPECIFIED;
+  return SCM_BOOL_T;
 }
 
+ADD_INTERFACE (Rest_collision,
+              "Move around ordinary rests (not multi-measure-rests) to avoid"
+              " conflicts.",
 
-ADD_INTERFACE (Rest_collision,"rest-collision-interface",
-  "Move around ordinary rests (not multi-measure-rests) to avoid "
-"conflicts.",
-  "maximum-rest-count minimum-distance positioning-done elements");
+              /* properties */
+              "minimum-distance "
+              "positioning-done "
+              "elements "
+              );