/*
- 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--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
- (c) 1997--2005 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.
+
+ You should have received a copy of the GNU General Public License
+ along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
*/
#include "rest-collision.hh"
-#include <math.h> // ceil.
+#include <cmath> // ceil.
+using namespace std;
-#include "warn.hh"
+#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 "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 "directional-element-interface.hh"
+#include "stem.hh"
+#include "grob.hh"
+#include "unpure-pure-container.hh"
+#include "warn.hh"
+#include "lily-imports.hh"
-MAKE_SCHEME_CALLBACK (Rest_collision,force_shift_callback,2);
+MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Rest_collision, force_shift_callback_rest, 2, 1, "");
SCM
-Rest_collision::force_shift_callback (SCM element_smob, SCM axis)
+Rest_collision::force_shift_callback_rest (SCM rest, SCM offset)
{
- Grob *them = unsmob_grob (element_smob);
- Axis a = (Axis) scm_to_int (axis);
- assert (a == Y_AXIS);
-
- if (Note_column::has_rests (them))
- {
- Grob * rc = unsmob_grob (them->get_property ("rest-collision"));
-
- if (rc && !to_boolean (rc->get_property ("positioning-done")))
- {
- rc->set_property ("positioning-done", SCM_BOOL_T);
- do_shift (rc);
- }
- }
- return scm_make_real (0.0);
-}
+ 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);
+
+ if (has_interface<Note_column> (parent) && Note_column::has_rests (parent))
+ {
+ Grob *collision = unsmob<Grob> (parent->get_object ("rest-collision"));
+ if (collision)
+ (void) collision->get_property ("positioning-done");
+ }
+
+ return scm_from_double (0.0);
+}
void
-Rest_collision::add_column (Grob*me,Grob *p)
+Rest_collision::add_column (Grob *me, Grob *p)
{
- 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.
+ p->set_object ("rest-collision", me->self_scm ());
- (not?)
- */
- p->add_offset_callback (Rest_collision::force_shift_callback_proc, Y_AXIS);
- p->set_property ("rest-collision", me->self_scm ());
+ Grob *rest = unsmob<Grob> (p->get_object ("rest"));
+ if (rest)
+ {
+ chain_offset_callback (rest,
+ Unpure_pure_container::make_smob
+ (Rest_collision::force_shift_callback_rest_proc,
+ Lily::pure_chain_offset_callback),
+ Y_AXIS);
+ }
}
-
+static bool
+rest_shift_less (Grob *const &r1, Grob *const &r2)
+{
+ Grob *col1 = r1->get_parent (X_AXIS);
+ Grob *col2 = r2->get_parent (X_AXIS);
+ return Note_column::shift_less (col1, col2);
+}
/*
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 (Grob *me)
+Rest_collision::calc_positioning_done (SCM smob)
{
- SCM elts = me->get_property ("elements");
+ Grob *me = unsmob<Grob> (smob);
+
+ me->set_property ("positioning-done", SCM_BOOL_T);
- Link_array<Grob> rests;
- Link_array<Grob> notes;
+ extract_grob_set (me, "elements", elts);
- for (SCM s = elts; scm_is_pair (s); s = scm_cdr (s))
+ vector<Grob *> rests;
+ vector<Grob *> notes;
+
+ for (vsize i = 0; i < elts.size (); i++)
{
- Grob * e = unsmob_grob (scm_car (s));
- if (unsmob_grob (e->get_property ("rest")))
- {
- /*
- Ignore rests under beam.
- */
- Grob* st = unsmob_grob (e->get_property ("stem"));
- if (st && unsmob_grob (st->get_property ("beam")))
- continue;
-
- rests.push (e);
- }
- else
- notes.push (e);
+ Grob *e = elts[i];
+ if (has_interface<Note_column> (e))
+ {
+ if (unsmob<Grob> (e->get_object ("rest")))
+ rests.push_back (e);
+ else
+ notes.push_back (e);
+ }
}
-
- /*
- handle rest-rest and rest-note collisions
+ /*
+ handle rest-rest and rest-note collisions
- [todo]
- * decide not to print rest if too crowded?
- */
+ [todo]
+ * decide not to print rest if too crowded?
+ */
/*
no partners to collide with
- */
+ */
if (rests.size () + notes.size () < 2)
- return SCM_UNSPECIFIED;
-
+ return SCM_BOOL_T;
Real staff_space = Staff_symbol_referencer::staff_space (me);
/*
only rests
*/
- if (!notes.size ())
+ if (!notes.size ())
{
/*
- 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++)
- {
- 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 (_("rest direction not set. Cannot resolve collision."));
- }
-
- Direction d = LEFT;
- do {
- ordered_rests[d].sort (Note_column::shift_compare);
- } while (flip (&d) != LEFT);
-
- do {
- if (ordered_rests[d].size () < 1)
- {
- if (ordered_rests[-d].size() > 1)
- ordered_rests[-d][0]->warning (_ ("too many colliding rests"));
-
- return SCM_UNSPECIFIED;
- }
- } while (flip (&d) != LEFT);
+ 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);
+ 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;
+ 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;
- 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)));
- }
-
- 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 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);
+ {
+ 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);
+ }
+ }
}
- else
+ 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;
-
- 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 * (notedim[dir] - restdim[-dir]) >? 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)));
-
- // 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);
+ 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_UNSPECIFIED;
+ return SCM_BOOL_T;
}
+ADD_INTERFACE (Rest_collision,
+ "Move ordinary rests (not multi-measure nor pitched rests)"
+ " to avoid conflicts.",
-ADD_INTERFACE (Rest_collision,"rest-collision-interface",
- "Move around ordinary rests (not multi-measure-rests) to avoid "
- "conflicts.",
- "minimum-distance positioning-done elements");
+ /* properties */
+ "minimum-distance "
+ "positioning-done "
+ "elements "
+ );
projects / lilypond.git / blobdiff