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.
24 #include "directional-element-interface.hh"
25 #include "duration.hh"
26 #include "international.hh"
28 #include "note-column.hh"
29 #include "output-def.hh"
30 #include "pointer-group-interface.hh"
32 #include "rhythmic-head.hh"
33 #include "staff-symbol-referencer.hh"
36 #include "unpure-pure-container.hh"
38 #include "lily-imports.hh"
42 MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Rest_collision, force_shift_callback_rest, 2, 1, "");
44 Rest_collision::force_shift_callback_rest (SCM rest, SCM offset)
46 Grob *rest_grob = unsmob<Grob> (rest);
47 Grob *parent = rest_grob->get_parent (X_AXIS);
50 translate REST; we need the result of this translation later on,
51 while the offset probably still is 0/calculation-in-progress.
53 if (scm_is_number (offset))
54 rest_grob->translate_axis (scm_to_double (offset), Y_AXIS);
56 if (has_interface<Note_column> (parent) && Note_column::has_rests (parent))
58 Grob *collision = unsmob<Grob> (parent->get_object ("rest-collision"));
61 (void) collision->get_property ("positioning-done");
64 return scm_from_double (0.0);
68 Rest_collision::add_column (Grob *me, Grob *p)
70 Pointer_group_interface::add_grob (me, ly_symbol2scm ("elements"), p);
72 p->set_object ("rest-collision", me->self_scm ());
74 Grob *rest = unsmob<Grob> (p->get_object ("rest"));
77 chain_offset_callback (rest,
78 Unpure_pure_container::make_smob
79 (Rest_collision::force_shift_callback_rest_proc,
80 Lily::pure_chain_offset_callback),
86 rest_shift_less (Grob *const &r1, Grob *const &r2)
88 Grob *col1 = r1->get_parent (X_AXIS);
89 Grob *col2 = r2->get_parent (X_AXIS);
90 return Note_column::shift_less (col1, col2);
94 TODO: look at horizontal-shift to determine ordering between rests
95 for more than two voices.
97 MAKE_SCHEME_CALLBACK (Rest_collision, calc_positioning_done, 1);
99 Rest_collision::calc_positioning_done (SCM smob)
101 Grob *me = unsmob<Grob> (smob);
103 me->set_property ("positioning-done", SCM_BOOL_T);
105 extract_grob_set (me, "elements", elts);
107 vector<Grob *> rests;
108 vector<Grob *> notes;
110 for (vsize i = 0; i < elts.size (); i++)
113 if (has_interface<Note_column> (e))
115 if (unsmob<Grob> (e->get_object ("rest")))
123 handle rest-rest and rest-note collisions
126 * decide not to print rest if too crowded?
130 no partners to collide with
132 if (rests.size () + notes.size () < 2)
135 Real staff_space = Staff_symbol_referencer::staff_space (me);
143 This is incomplete: in case of an uneven number of rests, the
144 center one should be centered on the staff.
146 Drul_array<vector<Grob *> > ordered_rests;
147 for (vsize i = 0; i < rests.size (); i++)
149 Grob *r = Note_column::get_rest (rests[i]);
151 Direction d = get_grob_direction (r);
153 ordered_rests[d].push_back (r);
155 rests[d]->warning (_ ("cannot resolve rest collision: rest direction not set"));
158 for (LEFT_and_RIGHT (d))
159 vector_sort (ordered_rests[d], rest_shift_less);
161 for (LEFT_and_RIGHT (d))
163 if (ordered_rests[d].size () < 1)
165 if (ordered_rests[-d].size () > 1)
166 ordered_rests[-d][0]->warning (_ ("too many colliding rests"));
172 Grob *common = common_refpoint_of_array (ordered_rests[DOWN], me, Y_AXIS);
173 common = common_refpoint_of_array (ordered_rests[UP], common, Y_AXIS);
176 = (ordered_rests[DOWN].back ()->extent (common, Y_AXIS)[UP]
177 - ordered_rests[UP].back ()->extent (common, Y_AXIS)[DOWN]) / staff_space;
181 int amount_down = (int) ceil (diff / 2);
183 Rest::translate (ordered_rests[DOWN].back (),
186 Rest::translate (ordered_rests[UP].back (),
187 2 * int (ceil (diff)));
190 for (LEFT_and_RIGHT (d))
192 for (vsize i = ordered_rests[d].size () - 1; i-- > 0;)
194 Real last_y = ordered_rests[d][i + 1]->extent (common, Y_AXIS)[d];
195 Real y = ordered_rests[d][i]->extent (common, Y_AXIS)[-d];
197 Real diff = d * ((last_y - y) / staff_space);
199 Rest::translate (ordered_rests[d][i], d * (int) ceil (diff) * 2);
208 // Count how many rests we move
209 Drul_array<int> rcount (0, 0);
211 for (vsize i = 0; i < rests.size (); i++)
213 Grob *rcol = rests[i];
214 Grob *rest = Note_column::get_rest (rcol);
216 Direction dir = get_grob_direction (rest);
218 dir = Note_column::dir (rcol);
220 // Do not compute a translation for pre-positioned rests,
221 // nor count them for the "too many colliding rests" warning
222 if (scm_is_number (rest->get_property ("staff-position")))
225 Grob *common = common_refpoint_of_array (notes, rcol, Y_AXIS);
226 Interval restdim = rest->extent (common, Y_AXIS);
227 if (restdim.is_empty ())
230 Real staff_space = Staff_symbol_referencer::staff_space (rcol);
231 Real minimum_dist = robust_scm2double (me->get_property ("minimum-distance"), 1.0) * staff_space;
234 for (vsize i = 0; i < notes.size (); i++)
236 if (Note_column::dir (notes[i]) == -dir
237 // If the note has already happened (but it has a long
238 // duration, so there is a collision), don't look at the stem.
239 // If we do, the rest gets shifted down a lot and it looks bad.
240 || dynamic_cast<Item *> (notes[i])->get_column () != dynamic_cast<Item *> (rest)->get_column ())
242 /* try not to look at the stem, as looking at a beamed
243 note may trigger beam positioning prematurely.
245 This happens with dotted rests, which need Y
246 positioning to compute X-positioning.
248 Grob *head = Note_column::first_head (notes[i]);
250 notedim.unite (head->extent (common, Y_AXIS));
252 programming_error ("Note_column without first_head()");
255 notedim.unite (notes[i]->extent (common, Y_AXIS));
258 Real y = dir * std::max (0.0,
259 -dir * restdim[-dir] + dir * notedim[dir] + minimum_dist);
261 // move discretely by half spaces.
262 int discrete_y = dir * int (ceil (y / (0.5 * dir * staff_space)));
264 Interval staff_span = Staff_symbol_referencer::staff_span (rest);
265 staff_span.widen (1);
266 // move by whole spaces inside the staff.
267 if (staff_span.contains
268 (Staff_symbol_referencer::get_position (rest) + discrete_y))
270 discrete_y = dir * int (ceil (dir * discrete_y / 2.0) * 2.0);
273 Rest::translate (rest, discrete_y);
275 rest->warning (_ ("too many colliding rests"));
281 ADD_INTERFACE (Rest_collision,
282 "Move ordinary rests (not multi-measure nor pitched rests)"
283 " to avoid conflicts.",