]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/rest-collision.cc
Fix some bugs in the dynamic engraver and PostScript backend
[lilypond.git] / lily / rest-collision.cc
index 969741809b67e05cbd271fb744fb2709edbc2672..589dd0dbecf9cb1e2739161b2dbbab691280a9df 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
-#include <math.h>              // ceil.
-
-#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 "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 "warn.hh"
 
-Real
-Rest_collision::force_shift_callback (Score_element *them, Axis a)
+MAKE_SCHEME_CALLBACK (Rest_collision, force_shift_callback, 1);
+SCM
+Rest_collision::force_shift_callback (SCM smob)
 {
-  assert (a == Y_AXIS);
-
-  Score_element * rc = unsmob_element (them->get_elt_pointer ("rest-collision"));
-
-  if (rc)
+  Grob *them = unsmob_grob (smob);
+  if (Note_column::has_rests (them))
     {
-      /*
-       Done: destruct pointers, so we do the shift only once.
-      */
-      SCM elts = rc->get_elt_pointer ("elements");
-      rc->set_elt_pointer ("elements", SCM_EOL);
+      Grob *collision = unsmob_grob (them->get_object ("rest-collision"));
 
-      do_shift (rc, elts);
+      if (collision)
+       {
+         (void) collision->get_property ("positioning-done");
+       }
     }
-  
-  return 0.0;
+  return scm_from_double (0.0);
 }
 
-void
-Rest_collision::add_column (Note_column *p)
+MAKE_SCHEME_CALLBACK (Rest_collision, force_shift_callback_rest, 2);
+SCM
+Rest_collision::force_shift_callback_rest (SCM rest, SCM offset)
 {
-  elt_l_->add_dependency (p);
-  Pointer_group_interface gi (elt_l_);  
-  gi.add_element (p);
+  Grob *rest_grob = unsmob_grob (rest);
+  Grob *parent = rest_grob->get_parent (X_AXIS);
 
-  p->add_offset_callback (&Rest_collision::force_shift_callback, Y_AXIS);
-  p->set_elt_pointer ("rest-collision", elt_l_->self_scm_);
+  /*
+    translate REST; we need the result of this translation later on,
+    while the offset probably still is 0/calculation-in-progress.
+   */
+  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);
 }
 
-/*
-  these 3 have to go, because they're unnecessary complications.
- */
-static Duration
-to_duration (int type, int dots)
+void
+Rest_collision::add_column (Grob *me, Grob *p)
 {
-  Duration d;
-  d.durlog_i_ = type;
-  d.dots_i_ = dots;
-  return d;
-}
+  Pointer_group_interface::add_grob (me, ly_symbol2scm ("elements"), p);
 
-/*
-  UGH
+  /*
+    only add callback for the rests, since we don't move anything
+    else.
 
-  elt_l_ should be "duration" independent
- */
-static Moment
-rhythmic_head2mom (Rhythmic_head* r)
-{
-  return to_duration (r->balltype_i (), r->dot_count ()).length_mom ();
-}
+    (not?)
+  */
+  add_offset_callback (p, Rest_collision::force_shift_callback_proc, Y_AXIS);
+  p->set_object ("rest-collision", me->self_scm ());
 
-/*
-  ugh
- */
-static Rhythmic_head*
-col2rhythmic_head (Score_element* c)
-{
-  return dynamic_cast<Rhythmic_head*> (unsmob_element (c->get_elt_pointer ("rest")));
+  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.
+*/
+MAKE_SCHEME_CALLBACK(Rest_collision, calc_positioning_done, 1);
 SCM
-Rest_collision::do_shift (Score_element *me, SCM elts)
+Rest_collision::calc_positioning_done (SCM smob)
 {
-  /*
-    ugh. -> score  elt type
-   */
-  Link_array<Note_column> rests;
-  Link_array<Note_column> notes;
+  Grob *me = unsmob_grob (smob);
+  extract_grob_set (me, "elements", elts);
 
-  for (SCM s = elts; gh_pair_p (s); s = gh_cdr (s))
+  vector<Grob*> rests;
+  vector<Grob*> notes;
+
+  for (vsize i = 0; i < elts.size (); i++)
     {
-      Score_element * e = unsmob_element (gh_car (s));
-      if (e && unsmob_element (e->get_elt_pointer ("rest")))
-       rests.push (dynamic_cast<Note_column*> (e));
+      Grob *e = elts[i];
+      if (unsmob_grob (e->get_object ("rest")))
+       {
+         /*
+           Ignore rests under beam.
+         */
+         Grob *st = unsmob_grob (e->get_object ("stem"));
+         if (st && unsmob_grob (st->get_object ("beam")))
+           continue;
+
+         rests.push_back (e);
+       }
       else
-       notes.push (dynamic_cast<Note_column*> (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_UNDEFINED;
+    [todo]
+    * decide not to print rest if too crowded?
+    */
 
-  // no partners to collide with
-  if (rests.size() + notes.size () < 2)
-    return SCM_UNDEFINED;
+  /*
+    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 ())
     {
-      Moment m = rhythmic_head2mom (col2rhythmic_head (rests[0]));
-      int i = 1;
-      for (; i < rests.size (); i++)
-       {
-         Moment me = rhythmic_head2mom (col2rhythmic_head (rests[i]));
-         if (me != m)
-           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).
-       */
-      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 ())
+       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++)
        {
-         display_count = gh_scm2int (s);
-         for (; i > display_count; i--)
-           col2rhythmic_head (rests[i-1])
-             ->set_elt_property ("molecule-callback", SCM_BOOL_T);
+         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 (_ ("can't resolve rest collision: rest direction not set"));
        }
-      else
-       display_count = rests.size ();
-      
-      /*
-       UGH.  Should get dims from table.  Should have minimum dist.
-       */
-      int dy = display_count > 2 ? 6 : 4;
-      if (display_count > 1)
+
+      Direction d = LEFT;
+      do
+       vector_sort (ordered_rests[d], Note_column::shift_compare);
+      while (flip (&d) != LEFT)
+       ;
+
+      do
        {
-         rests[0]->translate_rests (dy);       
-         rests[1]->translate_rests (-dy);
+         if (ordered_rests[d].size () < 1)
+           {
+             if (ordered_rests[-d].size () > 1)
+               ordered_rests[-d][0]->warning (_ ("too many colliding rests"));
+
+             return SCM_UNSPECIFIED;
+           }
        }
-    }
-  // meisjes met jongetjes
-  else 
-    {
-      if (rests.size () > 1)
+      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;
+
+      if (diff > 0)
        {
-         warning (_("too many colliding rests"));
+         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 (notes.size () > 1)
+
+      do
        {
-         warning (_("too many notes for rest collision"));
+         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);
+           }
        }
-      Note_column * rcol = rests[0];
-
-      // try to be opposite of noteheads. 
-      Direction dir = - notes[0]->dir();
-
-      Interval restdim = rcol->rest_dim ();
-      if (restdim.empty_b ())
-       return SCM_UNDEFINED;
-      
-      // staff ref'd?
-      Real staff_space = me->paper_l()->get_var ("interline");
-
-       /* FIXME
-         staff_space =  rcol->rests[0]->staff_space ();
-       */
-      Real minimum_dist = gh_scm2double (me->get_elt_property ("minimum-distance")) * staff_space;
-      
+      while (flip (&d) != LEFT);
+    }
+  else
+    {
       /*
-       assumption: ref points are the same. 
-       */
-      Interval notedim;
-      for (int i = 0; i < notes.size(); i++) 
-       {
-         notedim.unite (notes[i]->extent (Y_AXIS));
-       }
+       Rests and notes.
+      */
+      if (rests.size () > 1)
+       warning (_ ("too many colliding rests"));
+      Grob *rcol = 0;
+      Direction dir = CENTER;
 
-      Interval inter (notedim);
-      inter.intersect (restdim);
+      for (vsize i = rests.size (); !rcol && i--;)
+       if (Note_column::dir (rests[i]))
+         {
+           dir = Note_column::dir (rests[i]);
+           rcol = rests[i];
+         }
 
-      Real dist =
-       minimum_dist +  dir * (notedim[dir] - restdim[-dir]) >? 0;
+      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 (vsize 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;
+       }
 
-      // FIXME
-      //int stafflines = 5; // rcol->rests[0]->line_count;
-      int stafflines = Staff_symbol_referencer_interface (me).line_count ();
-      // hurg?
-      stafflines = stafflines != 0 ? stafflines : 5;
-      
       // move discretely by half spaces.
-      int discrete_dist = int (ceil (dist / (0.5 *staff_space)));
+      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);
-      
-      rcol->translate_rests (dir * discrete_dist);
+      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_UNDEFINED;
+  return SCM_UNSPECIFIED;
 }
 
-void
-Rest_collision::set_interface ()
-{
-  elt_l_->set_extent_callback (0, X_AXIS);
-  elt_l_->set_extent_callback (0, Y_AXIS);
-  elt_l_->set_elt_pointer ("elements", SCM_EOL);
-}
+ADD_INTERFACE (Rest_collision, "rest-collision-interface",
+              "Move around ordinary rests (not multi-measure-rests) to avoid "
+              "conflicts.",
+
+              /* properties */
+              "minimum-distance "
+              "positioning-done "
+              "elements");
 
-Rest_collision::Rest_collision (Score_element* c)
-{
-  elt_l_ = c;
-}