2 rest-collision.cc -- implement Rest_collision
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
9 #include "rest-collision.hh"
11 #include <math.h> // ceil.
14 #include "note-column.hh"
16 #include "rhythmic-head.hh"
17 #include "output-def.hh"
19 #include "group-interface.hh"
20 #include "staff-symbol-referencer.hh"
21 #include "duration.hh"
22 #include "directional-element-interface.hh"
24 MAKE_SCHEME_CALLBACK (Rest_collision, force_shift_callback, 2);
26 Rest_collision::force_shift_callback (SCM element_smob, SCM axis)
28 Grob *them = unsmob_grob (element_smob);
29 Axis a = (Axis) scm_to_int (axis);
32 if (Note_column::has_rests (them))
34 Grob * rc = unsmob_grob (them->get_property ("rest-collision"));
36 if (rc && !to_boolean (rc->get_property ("positioning-done")))
38 rc->set_property ("positioning-done", SCM_BOOL_T);
42 return scm_make_real (0.0);
46 MAKE_SCHEME_CALLBACK (Rest_collision, force_shift_callback_rest, 2);
48 Rest_collision::force_shift_callback_rest (SCM rest, SCM axis)
50 Grob *rest_grob = unsmob_grob (rest);
51 assert ((Axis) scm_to_int (axis) == Y_AXIS);
53 Grob *parent = rest_grob->get_parent (X_AXIS);
54 if (Note_column::has_interface (parent))
55 return force_shift_callback (parent->self_scm(), axis);
57 return scm_make_real (0.0);
62 Rest_collision::add_column (Grob*me, Grob *p)
64 me->add_dependency (p);
65 Pointer_group_interface::add_grob (me, ly_symbol2scm ("elements"), p);
68 only add callback for the rests, since we don't move anything
73 p->add_offset_callback (Rest_collision::force_shift_callback_proc, Y_AXIS);
74 p->set_property ("rest-collision", me->self_scm ());
76 Grob *rest = unsmob_grob (p->get_property ("rest"));
79 rest->add_offset_callback (Rest_collision::force_shift_callback_rest_proc,
85 TODO: look at horizontal-shift to determine ordering between rests
86 for more than two voices.
90 Rest_collision::do_shift (Grob *me)
92 SCM elts = me->get_property ("elements");
94 Link_array<Grob> rests;
95 Link_array<Grob> notes;
97 for (SCM s = elts; scm_is_pair (s); s = scm_cdr (s))
99 Grob * e = unsmob_grob (scm_car (s));
100 if (unsmob_grob (e->get_property ("rest")))
103 Ignore rests under beam.
105 Grob* st = unsmob_grob (e->get_property ("stem"));
106 if (st && unsmob_grob (st->get_property ("beam")))
117 handle rest-rest and rest-note collisions
120 * decide not to print rest if too crowded?
124 no partners to collide with
126 if (rests.size () + notes.size () < 2)
127 return SCM_UNSPECIFIED;
130 Real staff_space = Staff_symbol_referencer::staff_space (me);
138 This is incomplete: in case of an uneven number of rests, the
139 center one should be centered on the staff.
141 Drul_array< Link_array <Grob > > ordered_rests;
142 for (int i = 0; i < rests.size (); i++)
144 Grob * r = Note_column::get_rest (rests[i]);
146 Direction d = get_grob_direction (r);
149 ordered_rests[d].push (rests[i]);
152 rests[d]->warning (_("rest direction not set. Cannot resolve collision."));
157 ordered_rests[d].sort (Note_column::shift_compare);
158 } while (flip (&d) != LEFT);
161 if (ordered_rests[d].size () < 1)
163 if (ordered_rests[-d].size() > 1)
164 ordered_rests[-d][0]->warning (_ ("too many colliding rests"));
166 return SCM_UNSPECIFIED;
168 } while (flip (&d) != LEFT);
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].top ()->extent (common, Y_AXIS)[UP]
175 - ordered_rests[UP].top ()->extent (common, Y_AXIS)[DOWN]) / staff_space;
179 int amount_down = (int) ceil (diff / 2);
181 Note_column::translate_rests (ordered_rests[DOWN].top (),
184 Note_column::translate_rests (ordered_rests[UP].top (),
185 2 * int (ceil (diff)));
189 for (int i = ordered_rests[d].size () -1; i-- > 0;)
191 Real last_y = ordered_rests[d][i+1]->extent (common, Y_AXIS)[d];
192 Real y = ordered_rests[d][i]->extent (common, Y_AXIS)[-d];
194 Real diff = d * ((last_y - y) /staff_space);
196 Note_column::translate_rests (ordered_rests[d][i], d * (int) ceil (diff) * 2);
198 } while (flip (&d) != LEFT);
205 if (rests.size () > 1)
207 warning (_ ("too many colliding rests"));
210 Direction dir = CENTER;
212 for (int i = rests.size (); !rcol && i--;)
213 if (Note_column::dir (rests[i]))
215 dir = Note_column::dir (rests[i]);
220 return SCM_UNSPECIFIED;
222 Grob *common = common_refpoint_of_array (notes, rcol, Y_AXIS);
224 Interval restdim = rcol->extent (common, Y_AXIS);
225 if (restdim.is_empty ())
226 return SCM_UNSPECIFIED;
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 (int i = 0; i < notes.size (); i++)
234 notedim.unite (notes[i]->extent (common, Y_AXIS));
238 minimum_dist + dir * (notedim[dir] - restdim[-dir]) >? 0;
240 int stafflines = Staff_symbol_referencer::line_count (me);
243 programming_error ("No staff line count ? ");
247 // move discretely by half spaces.
248 int discrete_dist = int (ceil (dist / (0.5 *staff_space)));
250 // move by whole spaces inside the staff.
251 if (discrete_dist < stafflines+1)
252 discrete_dist = int (ceil (discrete_dist / 2.0)* 2.0);
254 Note_column::translate_rests (rcol, dir * discrete_dist);
256 return SCM_UNSPECIFIED;
260 ADD_INTERFACE (Rest_collision, "rest-collision-interface",
261 "Move around ordinary rests (not multi-measure-rests) to avoid "
263 "minimum-distance positioning-done elements");