2 accidental-placement.cc -- implement Accidental_placement
4 source file of the GNU LilyPond music typesetter
6 (c) 2002--2009 Han-Wen Nienhuys <hanwen@xs4all.nl>
10 #include "accidental-placement.hh"
13 #include "rhythmic-head.hh"
14 #include "accidental-interface.hh"
16 #include "note-collision.hh"
17 #include "note-column.hh"
18 #include "pointer-group-interface.hh"
20 #include "stream-event.hh"
25 Accidental_placement::add_accidental (Grob *me, Grob *a)
27 a->set_parent (me, X_AXIS);
28 a->set_property ("X-offset", Grob::x_parent_positioning_proc);
29 SCM cause = a->get_parent (Y_AXIS)->get_property ("cause");
31 Stream_event *mcause = unsmob_stream_event (cause);
34 programming_error ("note head has no event cause");
38 Pitch *p = unsmob_pitch (mcause->get_property ("pitch"));
40 int n = p->get_notename ();
42 SCM accs = me->get_object ("accidental-grobs");
43 SCM key = scm_from_int (n);
44 SCM entry = scm_assq (key, accs);
45 if (entry == SCM_BOOL_F)
48 entry = scm_cdr (entry);
50 entry = scm_cons (a->self_scm (), entry);
52 accs = scm_assq_set_x (accs, key, entry);
54 me->set_object ("accidental-grobs", accs);
58 Split into break reminders.
61 Accidental_placement::split_accidentals (Grob *accs,
62 vector<Grob*> *break_reminder,
63 vector<Grob*> *real_acc)
65 for (SCM acs = accs->get_object ("accidental-grobs"); scm_is_pair (acs);
67 for (SCM s = scm_cdar (acs); scm_is_pair (s); s = scm_cdr (s))
69 Grob *a = unsmob_grob (scm_car (s));
71 if (unsmob_grob (a->get_object ("tie"))
72 && !to_boolean (a->get_property ("forced")))
73 break_reminder->push_back (a);
75 real_acc->push_back (a);
80 Accidental_placement::get_relevant_accidentals (vector<Grob*> const &elts, Grob *left)
85 bool right = dynamic_cast<Item *> (left)->break_status_dir () == RIGHT;
87 for (vsize i = 0; i < elts.size (); i++)
89 split_accidentals (elts[i], &br, &ra);
91 ret.insert (ret.end (), ra.begin (), ra.end ());
94 ret.insert (ret.end (), br.begin (), br.end ());
99 struct Accidental_placement_entry
101 Skyline left_skyline_;
102 Skyline right_skyline_;
103 Interval vertical_extent_;
104 vector<Box> extents_;
105 vector<Grob*> grobs_;
108 Real ape_priority (Accidental_placement_entry const *a)
110 return a->vertical_extent_[UP];
113 int ape_compare (Accidental_placement_entry *const &a,
114 Accidental_placement_entry *const &b)
116 return sign (ape_priority (a) - ape_priority (b));
119 bool ape_less (Accidental_placement_entry *const &a,
120 Accidental_placement_entry *const &b)
122 return ape_priority (a) < ape_priority (b);
125 int ape_rcompare (Accidental_placement_entry *const &a,
126 Accidental_placement_entry *const &b)
128 return -sign (ape_priority (a) - ape_priority (b));
140 stagger_apes (vector<Accidental_placement_entry*> *apes)
142 vector<Accidental_placement_entry*> asc = *apes;
144 vector_sort (asc, &ape_less);
149 for (vsize i = 0; i < asc.size ();)
151 Accidental_placement_entry *a = 0;
167 static vector<Accidental_placement_entry*>
168 build_apes (SCM accs)
170 vector<Accidental_placement_entry*> apes;
171 for (SCM s = accs; scm_is_pair (s); s = scm_cdr (s))
173 Accidental_placement_entry *ape = new Accidental_placement_entry;
175 for (SCM t = scm_cdar (s); scm_is_pair (t); t = scm_cdr (t))
176 ape->grobs_.push_back (unsmob_grob (scm_car (t)));
178 apes.push_back (ape);
185 set_ape_skylines (Accidental_placement_entry *ape,
188 for (vsize i = ape->grobs_.size (); i--;)
190 Grob *a = ape->grobs_[i];
191 vector<Box> boxes = Accidental_interface::accurate_boxes (a, common);
192 ape->extents_.insert (ape->extents_.end (), boxes.begin (), boxes.end ());
194 for (vsize j = boxes.size (); j--;)
195 ape->vertical_extent_.unite (boxes[j][Y_AXIS]);
197 ape->left_skyline_ = Skyline (ape->extents_, 0, Y_AXIS, LEFT);
198 ape->right_skyline_ = Skyline (ape->extents_, 0, Y_AXIS, RIGHT);
202 extract_heads_and_stems (vector<Accidental_placement_entry*> const &apes)
204 vector<Grob*> note_cols;
207 for (vsize i = apes.size (); i--;)
209 Accidental_placement_entry *ape = apes[i];
210 for (vsize j = ape->grobs_.size (); j--;)
212 Grob *acc = ape->grobs_[j];
213 Grob *head = acc->get_parent (Y_AXIS);
214 Grob *col = head->get_parent (X_AXIS);
216 if (Note_column::has_interface (col))
217 note_cols.push_back (col);
219 ret.push_back (head);
224 This is a little kludgy: in case there are note columns without
225 accidentals, we get them from the Note_collision objects.
227 for (vsize i = note_cols.size (); i--;)
229 Grob *c = note_cols[i]->get_parent (X_AXIS);
230 if (Note_collision_interface::has_interface (c))
232 extract_grob_set (c, "elements", columns);
233 concat (note_cols, columns);
237 /* Now that we have all of the columns, grab all of the note-heads */
238 for (vsize i = note_cols.size (); i--;)
239 concat (ret, extract_grob_array (note_cols[i], "note-heads"));
241 /* Now that we have all of the heads, grab all of the stems */
242 for (vsize i = ret.size (); i--;)
243 if (Grob *s = Rhythmic_head::get_stem (ret[i]))
247 vector_sort (ret, less<Grob*> ());
253 common_refpoint_of_accidentals (vector<Accidental_placement_entry*> const &apes, Axis a)
257 for (vsize i = apes.size (); i--;)
258 for (vsize j = apes[i]->grobs_.size (); j--;)
261 ret = apes[i]->grobs_[j];
263 ret = ret->common_refpoint (apes[i]->grobs_[j], a);
270 build_heads_skyline (vector<Grob*> const &heads_and_stems,
273 vector<Box> head_extents;
274 for (vsize i = heads_and_stems.size (); i--;)
275 head_extents.push_back (Box (heads_and_stems[i]->extent (common[X_AXIS], X_AXIS),
276 heads_and_stems[i]->pure_height (common[Y_AXIS], 0, INT_MAX)));
278 return Skyline (head_extents, 0, Y_AXIS, LEFT);
282 Position the apes, starting from the right, so that they don't collide.
283 Return the total width.
286 position_apes (Grob *me,
287 vector<Accidental_placement_entry*> const &apes,
288 Skyline const &heads_skyline)
290 Real padding = robust_scm2double (me->get_property ("padding"), 0.2);
291 Skyline left_skyline = heads_skyline;
292 left_skyline.raise (-robust_scm2double (me->get_property ("right-padding"), 0));
295 Add accs entries right-to-left.
298 Real last_offset = 0.0;
299 for (vsize i = apes.size (); i-- > 0;)
301 Accidental_placement_entry *ape = apes[i];
303 Real offset = -ape->right_skyline_.distance (left_skyline);
305 offset = last_offset;
309 Skyline new_left_skyline = ape->left_skyline_;
310 new_left_skyline.raise (offset);
311 new_left_skyline.merge (left_skyline);
312 left_skyline = new_left_skyline;
314 /* Shift all of the accidentals in this ape */
315 for (vsize j = ape->grobs_.size (); j--;)
316 ape->grobs_[j]->translate_axis (offset, X_AXIS);
318 for (vsize j = ape->extents_.size (); j--;)
319 width.unite (offset + ape->extents_[j][X_AXIS]);
321 last_offset = offset;
329 This routine computes placements of accidentals. During
330 add_accidental (), accidentals are already grouped by note, so that
331 octaves are placed above each other; they form columns. Then the
332 columns are sorted: the biggest columns go closest to the note.
333 Then the columns are spaced as closely as possible (using skyline
337 TODO: more advanced placement. Typically, the accs should be placed
338 to form a C shape, like this
347 The naturals should be left of the C as well; they should
350 Note that this placement problem looks NP hard, so we just use a
351 simple strategy, not an optimal choice.
355 TODO: there should be more space in the following situation
369 MAKE_SCHEME_CALLBACK (Accidental_placement, calc_positioning_done, 1);
371 Accidental_placement::calc_positioning_done (SCM smob)
373 Grob *me = unsmob_grob (smob);
377 me->set_property ("positioning-done", SCM_BOOL_T);
379 SCM accs = me->get_object ("accidental-grobs");
380 if (!scm_is_pair (accs))
383 vector<Accidental_placement_entry*> apes = build_apes (accs);
385 Grob *common[] = {me, 0};
387 vector<Grob*> heads_and_stems = extract_heads_and_stems (apes);
389 common[Y_AXIS] = common_refpoint_of_accidentals (apes, Y_AXIS);
390 common[Y_AXIS] = common_refpoint_of_array (heads_and_stems, common[Y_AXIS], Y_AXIS);
391 common[X_AXIS] = common_refpoint_of_array (heads_and_stems, me, X_AXIS);
393 for (vsize i = apes.size (); i--;)
394 set_ape_skylines (apes[i], common);
395 Skyline heads_skyline = build_heads_skyline (heads_and_stems, common);
397 stagger_apes (&apes);
398 Interval width = position_apes (me, apes, heads_skyline);
400 me->flush_extent_cache (X_AXIS);
401 me->set_property ("X-extent", ly_interval2scm (width));
403 junk_pointers (apes);
408 ADD_INTERFACE (Accidental_placement,
409 "Resolve accidental collisions.",