source file of the GNU LilyPond music typesetter
- (c) 1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1997--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
*/
-#include <math.h> // ceil.
-#include "beam.hh"
-#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 "note-head.hh"
-#include "collision.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 "stem.hh"
+#include "grob.hh"
+#include "warn.hh"
-void
-Rest_collision::add_column (Note_column *nc_l)
+MAKE_SCHEME_CALLBACK (Rest_collision, force_shift_callback, 1);
+SCM
+Rest_collision::force_shift_callback (SCM smob)
{
- add_dependency (nc_l);
- Group_interface gi (this);
- if (nc_l->rest_b ())
- gi.name_ = "rests";
- else
- gi.name_ = "notes";
+ 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);
+}
+
+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);
- gi.add_element (nc_l);
+ if (Note_column::has_interface (parent))
+ force_shift_callback (parent->self_scm ());
+
+ return scm_from_double (0.0);
}
void
-Rest_collision::do_pre_processing()
+Rest_collision::add_column (Grob *me, Grob *p)
{
- Link_array<Note_column> rest_l_arr =
- Group_interface__extract_elements (this, (Note_column*) 0, "rests");
- Link_array<Note_column> ncol_l_arr =
- Group_interface__extract_elements (this, (Note_column*) 0, "notes");
-
-
- /*
- handle rest-rest and rest-note collisions
+ Pointer_group_interface::add_grob (me, ly_symbol2scm ("elements"), p);
- [todo]
- * decide not to print rest if too crowded?
+ /*
+ only add callback for the rests, since we don't move anything
+ else.
- * ignore rests under beams.
- */
+ (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);
+ }
+}
+
+/*
+ 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)
+{
+ Grob *me = unsmob_grob (smob);
- // no rests to collide
- if (!rest_l_arr.size())
- return;
+ me->set_property ("positioning-done", SCM_BOOL_T);
- // no partners to collide with
- if (rest_l_arr.size() + ncol_l_arr.size () < 2)
- return;
+ extract_grob_set (me, "elements", elts);
- // meisjes met meisjes
- if (!ncol_l_arr.size())
+ vector<Grob*> rests;
+ vector<Grob*> notes;
+
+ for (vsize 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")))
+ 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 ())
{
- 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<vector<Grob*> > ordered_rests;
+ for (vsize 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_back (rests[i]);
+ else
+ rests[d]->warning (_ ("cannot resolve rest collision: rest direction not set"));
}
- if (ncol_l_arr.size () > 1)
+
+ Direction d = LEFT;
+ do
+ vector_sort (ordered_rests[d], Note_column::shift_less);
+ 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_BOOL_T;
+ }
}
- Note_column * rcol = rest_l_arr[0];
+ while (flip (&d) != LEFT);
- // try to be opposite of noteheads.
- Direction dir = - ncol_l_arr[0]->dir();
+ Grob *common = common_refpoint_of_array (ordered_rests[DOWN], me, Y_AXIS);
+ common = common_refpoint_of_array (ordered_rests[UP], common, Y_AXIS);
- Interval restdim = rcol->rest_dim ();
- if (restdim.empty_b ())
- return;
-
- // staff ref'd?
- Real staff_space = paper_l()->get_var ("interline");
-
- /* FIXME
- staff_space = rcol->rest_l_arr[0]->staff_space ();
- */
- Real half_staff_space_f = staff_space/2;
- Real minimum_dist = paper_l ()->get_var ("restcollision_minimum_dist")
- * half_staff_space_f;
-
- /*
- assumption: ref points are the same.
- */
- Interval notedim;
- for (int i = 0; i < ncol_l_arr.size(); i++)
+ 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)
{
- 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].back (),
+ -2 * amount_down);
+ if (diff > 0)
+ Note_column::translate_rests (ordered_rests[UP].back (),
+ 2 * int (ceil (diff)));
}
- Interval inter (notedim);
- inter.intersect (restdim);
+ 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 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 (vsize i = rests.size (); !rcol && i--;)
+ if (Note_column::dir (rests[i]))
+ {
+ rcol = rests[i];
+ dir = Note_column::dir (rcol);
+ }
- // FIXME
- //int stafflines = 5; // rcol->rest_l_arr[0]->line_count;
- int stafflines = Staff_symbol_referencer_interface (this).line_count ();
- // hurg?
- stafflines = stafflines != 0 ? stafflines : 5;
+ 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++)
+ 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_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);
-
- rcol->translate_rests (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_BOOL_T;
}
+ADD_INTERFACE (Rest_collision,
+ "Move around ordinary rests (not multi-measure-rests) to avoid "
+ "conflicts.",
-Rest_collision::Rest_collision()
-{
- set_elt_property ("rests", SCM_EOL);
- set_elt_property ("notes", SCM_EOL);
- set_elt_property ("transparent", SCM_BOOL_T);
- set_empty (X_AXIS);
- set_empty (Y_AXIS);
-}
+ /* properties */
+ "minimum-distance "
+ "positioning-done "
+ "elements");