2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2012 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"
39 MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Rest_collision, force_shift_callback_rest, 2, 1, "");
41 Rest_collision::force_shift_callback_rest (SCM rest, SCM offset)
43 Grob *rest_grob = unsmob_grob (rest);
44 Grob *parent = rest_grob->get_parent (X_AXIS);
47 translate REST; we need the result of this translation later on,
48 while the offset probably still is 0/calculation-in-progress.
50 if (scm_is_number (offset))
51 rest_grob->translate_axis (scm_to_double (offset), Y_AXIS);
53 if (Note_column::has_interface (parent) && Note_column::has_rests (parent))
55 Grob *collision = unsmob_grob (parent->get_object ("rest-collision"));
58 (void) collision->get_property ("positioning-done");
61 return scm_from_double (0.0);
65 Rest_collision::add_column (Grob *me, Grob *p)
67 Pointer_group_interface::add_grob (me, ly_symbol2scm ("elements"), p);
69 p->set_object ("rest-collision", me->self_scm ());
71 Grob *rest = unsmob_grob (p->get_object ("rest"));
74 chain_offset_callback (rest,
75 Rest_collision::force_shift_callback_rest_proc, Y_AXIS);
80 rest_shift_less (Grob *const &r1, Grob *const &r2)
82 Grob *col1 = r1->get_parent (X_AXIS);
83 Grob *col2 = r2->get_parent (X_AXIS);
84 return Note_column::shift_less (col1, col2);
88 TODO: look at horizontal-shift to determine ordering between rests
89 for more than two voices.
91 MAKE_SCHEME_CALLBACK (Rest_collision, calc_positioning_done, 1);
93 Rest_collision::calc_positioning_done (SCM smob)
95 Grob *me = unsmob_grob (smob);
97 me->set_property ("positioning-done", SCM_BOOL_T);
99 extract_grob_set (me, "elements", elts);
101 vector<Grob *> rests;
102 vector<Grob *> notes;
104 for (vsize i = 0; i < elts.size (); i++)
107 if (unsmob_grob (e->get_object ("rest")))
114 handle rest-rest and rest-note collisions
117 * decide not to print rest if too crowded?
121 no partners to collide with
123 if (rests.size () + notes.size () < 2)
126 Real staff_space = Staff_symbol_referencer::staff_space (me);
134 This is incomplete: in case of an uneven number of rests, the
135 center one should be centered on the staff.
137 Drul_array<vector<Grob *> > ordered_rests;
138 for (vsize i = 0; i < rests.size (); i++)
140 Grob *r = Note_column::get_rest (rests[i]);
142 Direction d = get_grob_direction (r);
144 ordered_rests[d].push_back (r);
146 rests[d]->warning (_ ("cannot resolve rest collision: rest direction not set"));
151 vector_sort (ordered_rests[d], rest_shift_less);
152 while (flip (&d) != LEFT)
157 if (ordered_rests[d].size () < 1)
159 if (ordered_rests[-d].size () > 1)
160 ordered_rests[-d][0]->warning (_ ("too many colliding rests"));
165 while (flip (&d) != LEFT);
167 Grob *common = common_refpoint_of_array (ordered_rests[DOWN], me, Y_AXIS);
168 common = common_refpoint_of_array (ordered_rests[UP], common, Y_AXIS);
171 = (ordered_rests[DOWN].back ()->extent (common, Y_AXIS)[UP]
172 - ordered_rests[UP].back ()->extent (common, Y_AXIS)[DOWN]) / staff_space;
176 int amount_down = (int) ceil (diff / 2);
178 Rest::translate (ordered_rests[DOWN].back (),
181 Rest::translate (ordered_rests[UP].back (),
182 2 * int (ceil (diff)));
187 for (vsize i = ordered_rests[d].size () - 1; i-- > 0;)
189 Real last_y = ordered_rests[d][i + 1]->extent (common, Y_AXIS)[d];
190 Real y = ordered_rests[d][i]->extent (common, Y_AXIS)[-d];
192 Real diff = d * ((last_y - y) / staff_space);
194 Rest::translate (ordered_rests[d][i], d * (int) ceil (diff) * 2);
197 while (flip (&d) != LEFT);
204 // Count how many rests we move
205 Drul_array<int> rcount (0, 0);
207 for (vsize i = 0; i < rests.size (); i++)
209 Grob *rcol = rests[i];
210 Grob *rest = Note_column::get_rest (rcol);
212 Direction dir = get_grob_direction (rest);
214 dir = Note_column::dir (rcol);
216 // Do not compute a translation for pre-positioned rests,
217 // nor count them for the "too many colliding rests" warning
218 if (scm_is_number (rest->get_property ("staff-position")))
221 Grob *common = common_refpoint_of_array (notes, rcol, Y_AXIS);
222 Interval restdim = rest->extent (common, Y_AXIS);
223 if (restdim.is_empty ())
226 Real staff_space = Staff_symbol_referencer::staff_space (rcol);
227 Real minimum_dist = robust_scm2double (me->get_property ("minimum-distance"), 1.0) * staff_space;
230 for (vsize i = 0; i < notes.size (); i++)
232 if (Note_column::dir (notes[i]) == -dir
233 // If the note has already happened (but it has a long
234 // duration, so there is a collision), don't look at the stem.
235 // If we do, the rest gets shifted down a lot and it looks bad.
236 || dynamic_cast<Item *> (notes[i])->get_column () != dynamic_cast<Item *> (rest)->get_column ())
238 /* try not to look at the stem, as looking at a beamed
239 note may trigger beam positioning prematurely.
241 This happens with dotted rests, which need Y
242 positioning to compute X-positioning.
244 Grob *head = Note_column::first_head (notes[i]);
246 notedim.unite (head->extent (common, Y_AXIS));
248 programming_error ("Note_column without first_head()");
251 notedim.unite (notes[i]->extent (common, Y_AXIS));
254 Real y = dir * max (0.0,
255 -dir * restdim[-dir] + dir * notedim[dir] + minimum_dist);
257 int stafflines = Staff_symbol_referencer::line_count (me);
260 programming_error ("no staff line count");
264 // move discretely by half spaces.
265 int discrete_y = dir * int (ceil (y / (0.5 * dir * staff_space)));
267 // move by whole spaces inside the staff.
268 if (fabs (Staff_symbol_referencer::get_position (rest)
269 + discrete_y) < stafflines + 1)
271 discrete_y = dir * int (ceil (dir * discrete_y / 2.0) * 2.0);
274 Rest::translate (rest, discrete_y);
276 rest->warning (_ ("too many colliding rests"));
282 ADD_INTERFACE (Rest_collision,
283 "Move ordinary rests (not multi-measure nor pitched rests)"
284 " to avoid conflicts.",