/*
- rest-collision.cc -- implement Rest_collision
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
+ Copyright (C) 1997--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
- (c) 1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-*/
+ LilyPond is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ LilyPond is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
-#include <math.h> // ceil.
+ You should have received a copy of the GNU General Public License
+ along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
+*/
-#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 "item.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"
-Real
-Rest_collision::force_shift_callback (Score_element const*them, Axis a)
+MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Rest_collision, force_shift_callback_rest, 2, 1, "");
+SCM
+Rest_collision::force_shift_callback_rest (SCM rest, SCM offset)
{
- assert (a == Y_AXIS);
+ Grob *rest_grob = unsmob_grob (rest);
+ Grob *parent = rest_grob->get_parent (X_AXIS);
- Score_element * rc = unsmob_element (them->get_elt_pointer ("rest-collision"));
+ /*
+ 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);
- if (rc)
+ if (Note_column::has_interface (parent) && Note_column::has_rests (parent))
{
- /*
- 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 (parent->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)
+Rest_collision::add_column (Grob *me, Grob *p)
{
- elt_l_->add_dependency (p);
- Pointer_group_interface gi (elt_l_);
- gi.add_element (p);
+ Pointer_group_interface::add_grob (me, ly_symbol2scm ("elements"), p);
- p->add_offset_callback (&Rest_collision::force_shift_callback, Y_AXIS);
- p->set_elt_pointer ("rest-collision", elt_l_->self_scm_);
-}
+ p->set_object ("rest-collision", me->self_scm ());
-/*
- these 3 have to go, because they're unnecessary complications.
- */
-static Duration
-to_duration (int type, int dots)
-{
- Duration d;
- d.durlog_i_ = type;
- d.dots_i_ = dots;
- return d;
+ Grob *rest = unsmob_grob (p->get_object ("rest"));
+ if (rest)
+ {
+ chain_offset_callback (rest,
+ Rest_collision::force_shift_callback_rest_proc, Y_AXIS);
+ }
}
-/*
- UGH
-
- elt_l_ should be "duration" independent
- */
-static Moment
-rhythmic_head2mom (Rhythmic_head* r)
+static bool
+rest_shift_less (Grob *const &r1, Grob *const &r2)
{
- return to_duration (r->balltype_i (), r->dot_count ()).length_mom ();
+ Grob *col1 = r1->get_parent (X_AXIS);
+ Grob *col2 = r2->get_parent (X_AXIS);
+ return Note_column::shift_less (col1, col2);
}
/*
- ugh
- */
-static Rhythmic_head*
-col2rhythmic_head (Score_element* c)
+ 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)
{
- return dynamic_cast<Rhythmic_head*> (unsmob_element (c->get_elt_pointer ("rest")));
-}
+ Grob *me = unsmob_grob (smob);
+ me->set_property ("positioning-done", SCM_BOOL_T);
-/*
- TODO: fixme, fucks up if called twice on the same set of rests.
- */
-SCM
-Rest_collision::do_shift (Score_element *me, SCM elts)
-{
- /*
- ugh. -> score elt type
- */
- Link_array<Note_column> rests;
- Link_array<Note_column> notes;
+ 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_pointer ("rest")))
- rests.push (dynamic_cast<Note_column*> (e));
+ Grob *e = elts[i];
+ if (unsmob_grob (e->get_object ("rest")))
+ 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_BOOL_T;
- // 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 ())
- {
- display_count = gh_scm2int (s);
- for (; i > display_count; i--)
- col2rhythmic_head (rests[i-1])
- ->set_elt_property ("molecule-callback", SCM_BOOL_T);
- }
- 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)
- {
- rests[0]->translate_rests (dy);
- rests[1]->translate_rests (-dy);
- }
+ 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++)
+ {
+ Grob *r = Note_column::get_rest (rests[i]);
+
+ Direction d = get_grob_direction (r);
+ if (d)
+ ordered_rests[d].push_back (r);
+ else
+ rests[d]->warning (_ ("cannot resolve rest collision: rest direction not set"));
+ }
+
+ for (LEFT_and_RIGHT (d))
+ vector_sort (ordered_rests[d], rest_shift_less);
+
+ for (LEFT_and_RIGHT (d))
+ {
+ 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;
+ }
+ }
+
+ 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)
+ {
+ int amount_down = (int) ceil (diff / 2);
+ diff -= amount_down;
+ Rest::translate (ordered_rests[DOWN].back (),
+ -2 * amount_down);
+ if (diff > 0)
+ Rest::translate (ordered_rests[UP].back (),
+ 2 * int (ceil (diff)));
+ }
+
+ for (LEFT_and_RIGHT (d))
+ {
+ 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)
+ Rest::translate (ordered_rests[d][i], d * (int) ceil (diff) * 2);
+ }
+ }
}
- // meisjes met jongetjes
- else
+ else
{
- if (rests.size () > 1)
- {
- warning (_("too many colliding rests"));
- }
- if (notes.size () > 1)
- {
- warning (_("too many notes for rest collision"));
- }
- 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;
-
/*
- 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 dist =
- minimum_dist + dir * (notedim[dir] - restdim[-dir]) >? 0;
-
-
- // 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)));
-
- // 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);
+ Rests and notes.
+ */
+ // Count how many rests we move
+ Drul_array<int> rcount (0, 0);
+
+ for (vsize i = 0; i < rests.size (); i++)
+ {
+ Grob *rcol = rests[i];
+ Grob *rest = Note_column::get_rest (rcol);
+
+ Direction dir = get_grob_direction (rest);
+ if (!dir)
+ dir = Note_column::dir (rcol);
+
+ // Do not compute a translation for pre-positioned rests,
+ // nor count them for the "too many colliding rests" warning
+ if (scm_is_number (rest->get_property ("staff-position")))
+ continue;
+
+ Grob *common = common_refpoint_of_array (notes, rcol, Y_AXIS);
+ Interval restdim = rest->extent (common, Y_AXIS);
+ if (restdim.is_empty ())
+ continue;
+
+ 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++)
+ {
+ if (Note_column::dir (notes[i]) == -dir
+ // If the note has already happened (but it has a long
+ // duration, so there is a collision), don't look at the stem.
+ // If we do, the rest gets shifted down a lot and it looks bad.
+ || dynamic_cast<Item *> (notes[i])->get_column () != dynamic_cast<Item *> (rest)->get_column ())
+ {
+ /* 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));
+ }
+
+ Real y = dir * max (0.0,
+ -dir * restdim[-dir] + dir * notedim[dir] + minimum_dist);
+
+ // move discretely by half spaces.
+ int discrete_y = dir * int (ceil (y / (0.5 * dir * staff_space)));
+
+ Interval staff_span = Staff_symbol_referencer::staff_span (rest);
+ staff_span.widen (1);
+ // move by whole spaces inside the staff.
+ if (staff_span.contains
+ (Staff_symbol_referencer::get_position (rest) + discrete_y))
+ {
+ discrete_y = dir * int (ceil (dir * discrete_y / 2.0) * 2.0);
+ }
+
+ Rest::translate (rest, discrete_y);
+ if (rcount[dir]++)
+ rest->warning (_ ("too many colliding rests"));
+ }
}
- return SCM_UNDEFINED;
+ return SCM_BOOL_T;
}
-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,
+ "Move ordinary rests (not multi-measure nor pitched rests)"
+ " to avoid conflicts.",
+
+ /* properties */
+ "minimum-distance "
+ "positioning-done "
+ "elements "
+ );
-Rest_collision::Rest_collision (Score_element* c)
-{
- elt_l_ = c;
-}
projects / lilypond.git / blobdiff