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"
-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)
{
- Score_element *them = unsmob_element (element_smob);
- Axis a = (Axis) gh_scm2int (axis);
- assert (a == Y_AXIS);
-
- Score_element * rc = unsmob_element (them->get_elt_property ("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_property ("elements");
- rc->set_elt_property ("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 gh_double2scm (0.0);
+ return scm_from_double (0.0);
}
-void
-Rest_collision::add_column (Score_element*me,Score_element *p)
+MAKE_SCHEME_CALLBACK (Rest_collision, force_shift_callback_rest, 2);
+SCM
+Rest_collision::force_shift_callback_rest (SCM rest, SCM offset)
{
- me->add_dependency (p);
- Pointer_group_interface gi (me);
- 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_proc, Y_AXIS);
- p->set_elt_property ("rest-collision", me->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);
+}
-/*
- Combination of dot-count and duration-log.
- */
-static SCM
-head_characteristic (Score_element * col)
+void
+Rest_collision::add_column (Grob *me, Grob *p)
{
- Score_element * s = unsmob_element (col->get_elt_property ("rest"));
+ Pointer_group_interface::add_grob (me, ly_symbol2scm ("elements"), p);
- if (!s)
- return SCM_BOOL_F;
- else
- return gh_cons (s->get_elt_property ("duration-log"),
- gh_int2scm (Rhythmic_head::dot_count (s)));
+ /*
+ 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);
+ }
}
/*
- 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<Score_element> rests;
- Link_array<Score_element> notes;
+ Grob *me = unsmob_grob (smob);
+ extract_grob_set (me, "elements", elts);
+
+ vector<Grob*> rests;
+ vector<Grob*> notes;
- for (SCM s = elts; gh_pair_p (s); s = gh_cdr (s))
+ for (vsize i = 0; i < elts.size (); i++)
{
- Score_element * e = unsmob_element (gh_car (s));
- if (e && unsmob_element (e->get_elt_property ("rest")))
- rests.push (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 (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
- if (rests.size() + notes.size () < 2)
+ /*
+ 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 ())
{
- 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 (_ ("can't 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_elt_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_compare);
+ while (flip (&d) != LEFT)
+ ;
+
+ do
{
- display_count = gh_scm2int (s);
- for (; i > display_count; i--)
+ if (ordered_rests[d].size () < 1)
{
- Score_element* r = unsmob_element (rests[i-1]->get_elt_property ("rest"));
- if (r)
- r->suicide ();
- rests[i-1]->suicide ();
+ if (ordered_rests[-d].size () > 1)
+ ordered_rests[-d][0]->warning (_ ("too many colliding rests"));
+
+ return SCM_UNSPECIFIED;
}
}
- 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);
- 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)
+ 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)
{
- 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"));
- }
- if (notes.size () > 1)
- {
- warning (_("too many notes for rest collision"));
- }
- Score_element * rcol = rests[0];
+ warning (_ ("too many colliding rests"));
+ Grob *rcol = 0;
+ Direction dir = CENTER;
+
+ for (vsize 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;
- // try to be opposite of noteheads.
- Direction dir = - Note_column::dir (notes[0]);
+ Grob *common = common_refpoint_of_array (notes, rcol, Y_AXIS);
- Interval restdim = Note_column::rest_dim (rcol);
- if (restdim.empty_b ())
+ Interval restdim = rcol->extent (common, Y_AXIS);
+ if (restdim.is_empty ())
return SCM_UNSPECIFIED;
-
- // staff ref'd?
- Real staff_space = me->paper_l()->get_var ("staffspace");
-
- /* FIXME
- staff_space = rcol->rests[0]->staff_space ();
- */
- Real minimum_dist = gh_scm2double (me->get_elt_property ("minimum-distance")) * staff_space;
-
- /*
- assumption: ref points are the same.
- */
- Interval notedim;
- for (int i = 0; i < notes.size(); i++)
- {
- notedim.unite (notes[i]->extent (Y_AXIS));
- }
- Interval inter (notedim);
- inter.intersect (restdim);
+ Real staff_space = Staff_symbol_referencer::staff_space (rcol);
+ Real minimum_dist = robust_scm2double (me->get_property ("minimum-distance"), 1.0) * staff_space;
- Real dist =
- minimum_dist + dir * (notedim[dir] - restdim[-dir]) >? 0;
+ 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);
- // FIXME
- //int stafflines = 5; // rcol->rests[0]->line_count;
int stafflines = Staff_symbol_referencer::line_count (me);
- // hurg?
- stafflines = stafflines != 0 ? stafflines : 5;
-
+ 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);
-
- Note_column::translate_rests (rcol,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_UNSPECIFIED;
}
-void
-Rest_collision::set_interface (Score_element*me)
-{
- me->set_extent_callback (0, X_AXIS);
- me->set_extent_callback (0, Y_AXIS);
-}
+ADD_INTERFACE (Rest_collision, "rest-collision-interface",
+ "Move around ordinary rests (not multi-measure-rests) to avoid "
+ "conflicts.",
+
+ /* properties */
+ "minimum-distance "
+ "positioning-done "
+ "elements");