2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
6 LilyPond is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 LilyPond is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
20 #include "rest-collision.hh"
22 #include <cmath> // ceil.
25 #include "directional-element-interface.hh"
26 #include "duration.hh"
27 #include "international.hh"
29 #include "note-column.hh"
30 #include "output-def.hh"
31 #include "pointer-group-interface.hh"
33 #include "rhythmic-head.hh"
34 #include "staff-symbol-referencer.hh"
37 #include "unpure-pure-container.hh"
40 MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Rest_collision, force_shift_callback_rest, 2, 1, "");
42 Rest_collision::force_shift_callback_rest (SCM rest, SCM offset)
44 Grob *rest_grob = Grob::unsmob (rest);
45 Grob *parent = rest_grob->get_parent (X_AXIS);
48 translate REST; we need the result of this translation later on,
49 while the offset probably still is 0/calculation-in-progress.
51 if (scm_is_number (offset))
52 rest_grob->translate_axis (scm_to_double (offset), Y_AXIS);
54 if (Note_column::has_interface (parent) && Note_column::has_rests (parent))
56 Grob *collision = Grob::unsmob (parent->get_object ("rest-collision"));
59 (void) collision->get_property ("positioning-done");
62 return scm_from_double (0.0);
66 Rest_collision::add_column (Grob *me, Grob *p)
68 Pointer_group_interface::add_grob (me, ly_symbol2scm ("elements"), p);
70 p->set_object ("rest-collision", me->self_scm ());
72 Grob *rest = Grob::unsmob (p->get_object ("rest"));
75 chain_offset_callback (rest,
76 Unpure_pure_container::make_smob
77 (Rest_collision::force_shift_callback_rest_proc,
78 ly_lily_module_constant ("pure-chain-offset-callback")),
84 rest_shift_less (Grob *const &r1, Grob *const &r2)
86 Grob *col1 = r1->get_parent (X_AXIS);
87 Grob *col2 = r2->get_parent (X_AXIS);
88 return Note_column::shift_less (col1, col2);
92 TODO: look at horizontal-shift to determine ordering between rests
93 for more than two voices.
95 MAKE_SCHEME_CALLBACK (Rest_collision, calc_positioning_done, 1);
97 Rest_collision::calc_positioning_done (SCM smob)
99 Grob *me = Grob::unsmob (smob);
101 me->set_property ("positioning-done", SCM_BOOL_T);
103 extract_grob_set (me, "elements", elts);
105 vector<Grob *> rests;
106 vector<Grob *> notes;
108 for (vsize i = 0; i < elts.size (); i++)
111 if (Note_column::has_interface (e))
113 if (Grob::unsmob (e->get_object ("rest")))
121 handle rest-rest and rest-note collisions
124 * decide not to print rest if too crowded?
128 no partners to collide with
130 if (rests.size () + notes.size () < 2)
133 Real staff_space = Staff_symbol_referencer::staff_space (me);
141 This is incomplete: in case of an uneven number of rests, the
142 center one should be centered on the staff.
144 Drul_array<vector<Grob *> > ordered_rests;
145 for (vsize i = 0; i < rests.size (); i++)
147 Grob *r = Note_column::get_rest (rests[i]);
149 Direction d = get_grob_direction (r);
151 ordered_rests[d].push_back (r);
153 rests[d]->warning (_ ("cannot resolve rest collision: rest direction not set"));
156 for (LEFT_and_RIGHT (d))
157 vector_sort (ordered_rests[d], rest_shift_less);
159 for (LEFT_and_RIGHT (d))
161 if (ordered_rests[d].size () < 1)
163 if (ordered_rests[-d].size () > 1)
164 ordered_rests[-d][0]->warning (_ ("too many colliding rests"));
170 Grob *common = common_refpoint_of_array (ordered_rests[DOWN], me, Y_AXIS);
171 common = common_refpoint_of_array (ordered_rests[UP], common, Y_AXIS);
174 = (ordered_rests[DOWN].back ()->extent (common, Y_AXIS)[UP]
175 - ordered_rests[UP].back ()->extent (common, Y_AXIS)[DOWN]) / staff_space;
179 int amount_down = (int) ceil (diff / 2);
181 Rest::translate (ordered_rests[DOWN].back (),
184 Rest::translate (ordered_rests[UP].back (),
185 2 * int (ceil (diff)));
188 for (LEFT_and_RIGHT (d))
190 for (vsize i = ordered_rests[d].size () - 1; i-- > 0;)
192 Real last_y = ordered_rests[d][i + 1]->extent (common, Y_AXIS)[d];
193 Real y = ordered_rests[d][i]->extent (common, Y_AXIS)[-d];
195 Real diff = d * ((last_y - y) / staff_space);
197 Rest::translate (ordered_rests[d][i], d * (int) ceil (diff) * 2);
206 // Count how many rests we move
207 Drul_array<int> rcount (0, 0);
209 for (vsize i = 0; i < rests.size (); i++)
211 Grob *rcol = rests[i];
212 Grob *rest = Note_column::get_rest (rcol);
214 Direction dir = get_grob_direction (rest);
216 dir = Note_column::dir (rcol);
218 // Do not compute a translation for pre-positioned rests,
219 // nor count them for the "too many colliding rests" warning
220 if (scm_is_number (rest->get_property ("staff-position")))
223 Grob *common = common_refpoint_of_array (notes, rcol, Y_AXIS);
224 Interval restdim = rest->extent (common, Y_AXIS);
225 if (restdim.is_empty ())
228 Real staff_space = Staff_symbol_referencer::staff_space (rcol);
229 Real minimum_dist = robust_scm2double (me->get_property ("minimum-distance"), 1.0) * staff_space;
232 for (vsize i = 0; i < notes.size (); i++)
234 if (Note_column::dir (notes[i]) == -dir
235 // If the note has already happened (but it has a long
236 // duration, so there is a collision), don't look at the stem.
237 // If we do, the rest gets shifted down a lot and it looks bad.
238 || dynamic_cast<Item *> (notes[i])->get_column () != dynamic_cast<Item *> (rest)->get_column ())
240 /* try not to look at the stem, as looking at a beamed
241 note may trigger beam positioning prematurely.
243 This happens with dotted rests, which need Y
244 positioning to compute X-positioning.
246 Grob *head = Note_column::first_head (notes[i]);
248 notedim.unite (head->extent (common, Y_AXIS));
250 programming_error ("Note_column without first_head()");
253 notedim.unite (notes[i]->extent (common, Y_AXIS));
256 Real y = dir * max (0.0,
257 -dir * restdim[-dir] + dir * notedim[dir] + minimum_dist);
259 // move discretely by half spaces.
260 int discrete_y = dir * int (ceil (y / (0.5 * dir * staff_space)));
262 Interval staff_span = Staff_symbol_referencer::staff_span (rest);
263 staff_span.widen (1);
264 // move by whole spaces inside the staff.
265 if (staff_span.contains
266 (Staff_symbol_referencer::get_position (rest) + discrete_y))
268 discrete_y = dir * int (ceil (dir * discrete_y / 2.0) * 2.0);
271 Rest::translate (rest, discrete_y);
273 rest->warning (_ ("too many colliding rests"));
279 ADD_INTERFACE (Rest_collision,
280 "Move ordinary rests (not multi-measure nor pitched rests)"
281 " to avoid conflicts.",