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"
39 #include "lily-imports.hh"
43 MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Rest_collision, force_shift_callback_rest, 2, 1, "");
45 Rest_collision::force_shift_callback_rest (SCM rest, SCM offset)
47 Grob *rest_grob = unsmob<Grob> (rest);
48 Grob *parent = rest_grob->get_parent (X_AXIS);
51 translate REST; we need the result of this translation later on,
52 while the offset probably still is 0/calculation-in-progress.
54 if (scm_is_number (offset))
55 rest_grob->translate_axis (scm_to_double (offset), Y_AXIS);
57 if (has_interface<Note_column> (parent) && Note_column::has_rests (parent))
59 Grob *collision = unsmob<Grob> (parent->get_object ("rest-collision"));
62 (void) collision->get_property ("positioning-done");
65 return scm_from_double (0.0);
69 Rest_collision::add_column (Grob *me, Grob *p)
71 Pointer_group_interface::add_grob (me, ly_symbol2scm ("elements"), p);
73 p->set_object ("rest-collision", me->self_scm ());
75 Grob *rest = unsmob<Grob> (p->get_object ("rest"));
78 chain_offset_callback (rest,
79 Unpure_pure_container::make_smob
80 (Rest_collision::force_shift_callback_rest_proc,
81 Lily::pure_chain_offset_callback),
87 rest_shift_less (Grob *const &r1, Grob *const &r2)
89 Grob *col1 = r1->get_parent (X_AXIS);
90 Grob *col2 = r2->get_parent (X_AXIS);
91 return Note_column::shift_less (col1, col2);
95 TODO: look at horizontal-shift to determine ordering between rests
96 for more than two voices.
98 MAKE_SCHEME_CALLBACK (Rest_collision, calc_positioning_done, 1);
100 Rest_collision::calc_positioning_done (SCM smob)
102 Grob *me = unsmob<Grob> (smob);
104 me->set_property ("positioning-done", SCM_BOOL_T);
106 extract_grob_set (me, "elements", elts);
108 vector<Grob *> rests;
109 vector<Grob *> notes;
111 for (vsize i = 0; i < elts.size (); i++)
114 if (has_interface<Note_column> (e))
116 if (unsmob<Grob> (e->get_object ("rest")))
124 handle rest-rest and rest-note collisions
127 * decide not to print rest if too crowded?
131 no partners to collide with
133 if (rests.size () + notes.size () < 2)
136 Real staff_space = Staff_symbol_referencer::staff_space (me);
144 This is incomplete: in case of an uneven number of rests, the
145 center one should be centered on the staff.
147 Drul_array<vector<Grob *> > ordered_rests;
148 for (vsize i = 0; i < rests.size (); i++)
150 Grob *r = Note_column::get_rest (rests[i]);
152 Direction d = get_grob_direction (r);
154 ordered_rests[d].push_back (r);
156 rests[d]->warning (_ ("cannot resolve rest collision: rest direction not set"));
159 for (LEFT_and_RIGHT (d))
160 vector_sort (ordered_rests[d], rest_shift_less);
162 for (LEFT_and_RIGHT (d))
164 if (ordered_rests[d].size () < 1)
166 if (ordered_rests[-d].size () > 1)
167 ordered_rests[-d][0]->warning (_ ("too many colliding rests"));
173 Grob *common = common_refpoint_of_array (ordered_rests[DOWN], me, Y_AXIS);
174 common = common_refpoint_of_array (ordered_rests[UP], common, Y_AXIS);
177 = (ordered_rests[DOWN].back ()->extent (common, Y_AXIS)[UP]
178 - ordered_rests[UP].back ()->extent (common, Y_AXIS)[DOWN]) / staff_space;
182 int amount_down = (int) ceil (diff / 2);
184 Rest::translate (ordered_rests[DOWN].back (),
187 Rest::translate (ordered_rests[UP].back (),
188 2 * int (ceil (diff)));
191 for (LEFT_and_RIGHT (d))
193 for (vsize i = ordered_rests[d].size () - 1; i-- > 0;)
195 Real last_y = ordered_rests[d][i + 1]->extent (common, Y_AXIS)[d];
196 Real y = ordered_rests[d][i]->extent (common, Y_AXIS)[-d];
198 Real diff = d * ((last_y - y) / staff_space);
200 Rest::translate (ordered_rests[d][i], d * (int) ceil (diff) * 2);
209 // Count how many rests we move
210 Drul_array<int> rcount (0, 0);
212 for (vsize i = 0; i < rests.size (); i++)
214 Grob *rcol = rests[i];
215 Grob *rest = Note_column::get_rest (rcol);
217 Direction dir = get_grob_direction (rest);
219 dir = Note_column::dir (rcol);
221 // Do not compute a translation for pre-positioned rests,
222 // nor count them for the "too many colliding rests" warning
223 if (scm_is_number (rest->get_property ("staff-position")))
226 Grob *common = common_refpoint_of_array (notes, rcol, Y_AXIS);
227 Interval restdim = rest->extent (common, Y_AXIS);
228 if (restdim.is_empty ())
231 Real staff_space = Staff_symbol_referencer::staff_space (rcol);
232 Real minimum_dist = robust_scm2double (me->get_property ("minimum-distance"), 1.0) * staff_space;
235 for (vsize i = 0; i < notes.size (); i++)
237 if (Note_column::dir (notes[i]) == -dir
238 // If the note has already happened (but it has a long
239 // duration, so there is a collision), don't look at the stem.
240 // If we do, the rest gets shifted down a lot and it looks bad.
241 || dynamic_cast<Item *> (notes[i])->get_column () != dynamic_cast<Item *> (rest)->get_column ())
243 /* try not to look at the stem, as looking at a beamed
244 note may trigger beam positioning prematurely.
246 This happens with dotted rests, which need Y
247 positioning to compute X-positioning.
249 Grob *head = Note_column::first_head (notes[i]);
251 notedim.unite (head->extent (common, Y_AXIS));
253 programming_error ("Note_column without first_head()");
256 notedim.unite (notes[i]->extent (common, Y_AXIS));
259 Real y = dir * max (0.0,
260 -dir * restdim[-dir] + dir * notedim[dir] + minimum_dist);
262 // move discretely by half spaces.
263 int discrete_y = dir * int (ceil (y / (0.5 * dir * staff_space)));
265 Interval staff_span = Staff_symbol_referencer::staff_span (rest);
266 staff_span.widen (1);
267 // move by whole spaces inside the staff.
268 if (staff_span.contains
269 (Staff_symbol_referencer::get_position (rest) + discrete_y))
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.",