source file of the GNU LilyPond music typesetter
- (c) 1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
*/
-#include "beam.hh"
-#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 "pointer-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);
- if (nc_l->rest_b ())
- rest_l_arr_.push (nc_l);
+ 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_object ("rest-collision"));
+
+ if (rc && !to_boolean (rc->get_property ("positioning-done")))
+ {
+ rc->set_property ("positioning-done", SCM_BOOL_T);
+ do_shift (rc);
+ }
+ }
+ return scm_from_double (0.0);
+}
+
+MAKE_SCHEME_CALLBACK (Rest_collision, force_shift_callback_rest, 2);
+SCM
+Rest_collision::force_shift_callback_rest (SCM rest, SCM axis)
+{
+ 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_from_double (0.0);
}
void
-Rest_collision::do_pre_processing()
+Rest_collision::add_column (Grob *me, Grob *p)
{
- /*
- handle rest-rest and rest-note collisions
+ 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.
- [todo]
- * decide not to print rest if too crowded?
+ (not?)
+ */
+ p->add_offset_callback (Rest_collision::force_shift_callback_proc, Y_AXIS);
+ p->set_object ("rest-collision", me->self_scm ());
- * ignore rests under beams.
- */
+ Grob *rest = unsmob_grob (p->get_object ("rest"));
+ if (rest)
+ {
+ rest->add_offset_callback (Rest_collision::force_shift_callback_rest_proc,
+ Y_AXIS);
+ }
+}
- // no rests to collide
- if (!rest_l_arr_.size())
- return;
+/*
+ TODO: look at horizontal-shift to determine ordering between rests
+ for more than two voices.
+*/
+SCM
+Rest_collision::do_shift (Grob *me)
+{
+ extract_grob_set (me, "elements", elts);
- // no partners to collide with
- if (rest_l_arr_.size() + ncol_l_arr_.size () < 2)
- return;
+ Link_array<Grob> rests;
+ Link_array<Grob> notes;
- // meisjes met meisjes
- if (!ncol_l_arr_.size())
+ for (int i = 0; i < elts.size (); i++)
{
- /*
- UGH. Should get dims from table. Should have minimum dist.
- */
- 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);
+ 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 (e);
+ }
+ else
+ notes.push (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_UNSPECIFIED;
+
+ Real staff_space = Staff_symbol_referencer::staff_space (me);
+ /*
+ only rests
+ */
+ if (!notes.size ())
{
- if (rest_l_arr_.size () > 1)
+
+ /*
+ 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++)
{
- warning (_("Too many colliding rests."));
+ 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 collision: rest direction not set"));
}
- if (ncol_l_arr_.size () > 1)
+
+ Direction d = LEFT;
+ do
+ ordered_rests[d].sort (Note_column::shift_compare);
+ while (flip (&d) != LEFT)
+ ;
+
+ do
{
- warning (_("Too many notes for rest collision."));
+ if (ordered_rests[d].size () < 1)
+ {
+ if (ordered_rests[-d].size () > 1)
+ ordered_rests[-d][0]->warning (_ ("too many colliding rests"));
+
+ return SCM_UNSPECIFIED;
+ }
}
- Note_column * rcol = rest_l_arr_[0];
-
- // try to be opposite of noteheads.
- Direction dir = - ncol_l_arr_[0]->dir();
-
- Interval restdim;
- for (int i=0; i < rcol->rest_l_arr_.size(); i++)
- restdim.unite (rcol->rest_l_arr_[i]->extent (Y_AXIS));
-
- if (restdim.empty_b ())
- return;
-
- // staff ref'd?
- Real staff_space = rcol->rest_l_arr_[0]->staff_line_leading_f ();
- Real internote_f = staff_space/2;
- Real minimum_dist = paper_l ()->get_var ("restcollision_minimum_dist")
- * internote_f;
-
- /*
- assumption: ref points are the same.
- */
- Interval notedim;
- for (int i = 0; i < ncol_l_arr_.size(); i++)
+ 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)
{
- notedim.unite (ncol_l_arr_[i]->extent (Y_AXIS));
+ 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)));
}
- Interval inter (notedim);
- inter.intersect (restdim);
+ 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 dist =
- minimum_dist + dir * (notedim[dir] - restdim[-dir]) >? 0;
+ 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
+ {
+ /*
+ Rests and notes.
+ */
+ if (rests.size () > 1)
+ warning (_ ("too many colliding rests"));
+ Grob *rcol = 0;
+ Direction dir = CENTER;
+
+ for (int i = rests.size (); !rcol && i--;)
+ if (Note_column::dir (rests[i]))
+ {
+ dir = Note_column::dir (rests[i]);
+ rcol = rests[i];
+ }
+ if (!rcol)
+ return SCM_UNSPECIFIED;
- int stafflines = rcol->rest_l_arr_[0]->lines_i ();
+ 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)));
+ 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);
- }
-}
-
-void
-Rest_collision::do_print() const
-{
-#ifndef NPRINT
- DOUT << "rests: " << rest_l_arr_.size() << ", ";
- DOUT << "cols: " << ncol_l_arr_.size();
-#endif
-}
+ if (discrete_dist < stafflines + 1)
+ discrete_dist = int (ceil (discrete_dist / 2.0) * 2.0);
-void
-Rest_collision::do_substitute_element_pointer (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);
+ Note_column::translate_rests (rcol, dir * discrete_dist);
}
+ return SCM_UNSPECIFIED;
}
-Rest_collision::Rest_collision()
-{
- set_elt_property (transparent_scm_sym, SCM_BOOL_T);
- 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");
+