2 accidental-placement.cc -- implement Accidental_placement
4 source file of the GNU LilyPond music typesetter
6 (c) 2002--2007 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 break_reminder->push_back (a);
74 real_acc->push_back (a);
79 Accidental_placement::get_break_reminder_accidentals (vector<Grob*> const &elts, Grob *left)
85 if (dynamic_cast<Item *> (left)->break_status_dir () != RIGHT)
86 return vector<Grob*> ();
88 for (vsize i = 0; i < elts.size (); i++)
90 split_accidentals (elts[i], &br, &ra);
91 ret.insert (ret.end (), br.begin (), br.end ());
97 Accidentals are special, because they appear and disappear after
101 Accidental_placement::get_relevant_accidental_extent (Grob *me,
105 vector<Grob*> br, ra;
106 vector<Grob*> *which = 0;
108 Accidental_placement::split_accidentals (me, &br, &ra);
111 if (dynamic_cast<Item *> (left_object)->break_status_dir () == RIGHT)
117 for (vsize i = 0; i < which->size (); i++)
118 extent.unite (which->at (i)->extent (item_col, X_AXIS));
120 if (!extent.is_empty ())
122 Real p = robust_scm2double (me->get_property ("left-padding"), 0.2);
129 struct Accidental_placement_entry
131 Skyline left_skyline_;
132 Skyline right_skyline_;
133 Interval vertical_extent_;
134 vector<Box> extents_;
135 vector<Grob*> grobs_;
138 Accidental_placement_entry ()
145 static Interval all_accidental_vertical_extent;
146 Real ape_priority (Accidental_placement_entry const *a)
148 return a->vertical_extent_[UP];
151 int ape_compare (Accidental_placement_entry *const &a,
152 Accidental_placement_entry *const &b)
154 return sign (ape_priority (a) - ape_priority (b));
157 bool ape_less (Accidental_placement_entry *const &a,
158 Accidental_placement_entry *const &b)
160 return ape_priority (a) < ape_priority (b);
163 int ape_rcompare (Accidental_placement_entry *const &a,
164 Accidental_placement_entry *const &b)
166 return -sign (ape_priority (a) - ape_priority (b));
178 stagger_apes (vector<Accidental_placement_entry*> *apes)
180 vector<Accidental_placement_entry*> asc = *apes;
182 vector_sort (asc, &ape_less);
187 for (vsize i = 0; i < asc.size ();)
189 Accidental_placement_entry *a = 0;
206 This routine computes placements of accidentals. During
207 add_accidental (), accidentals are already grouped by note, so that
208 octaves are placed above each other; they form columns. Then the
209 columns are sorted: the biggest columns go closest to the note.
210 Then the columns are spaced as closely as possible (using skyline
214 TODO: more advanced placement. Typically, the accs should be placed
215 to form a C shape, like this
224 The naturals should be left of the C as well; they should
227 Note that this placement problem looks NP hard, so we just use a
228 simple strategy, not an optimal choice.
232 TODO: there should be more space in the following situation
246 MAKE_SCHEME_CALLBACK (Accidental_placement, calc_positioning_done, 1);
248 Accidental_placement::calc_positioning_done (SCM smob)
250 Grob *me = unsmob_grob (smob);
254 me->set_property ("positioning-done", SCM_BOOL_T);
256 SCM accs = me->get_object ("accidental-grobs");
257 if (!scm_is_pair (accs))
261 TODO: there is a bug in this code. If two accs are on the same
262 Y-position, they share an Ape, and will be printed in overstrike.
264 vector<Accidental_placement_entry*> apes;
265 for (SCM s = accs; scm_is_pair (s); s = scm_cdr (s))
267 Accidental_placement_entry *ape = new Accidental_placement_entry;
268 ape->notename_ = scm_to_int (scm_caar (s));
270 for (SCM t = scm_cdar (s); scm_is_pair (t); t = scm_cdr (t))
271 ape->grobs_.push_back (unsmob_grob (scm_car (t)));
273 apes.push_back (ape);
276 Grob *common[] = {me, 0};
279 First we must extract *all* pointers. We can only determine
280 extents if we're sure that we've found the right common refpoint
282 vector<Grob*> note_cols, heads;
283 for (vsize i = apes.size (); i--;)
285 Accidental_placement_entry *ape = apes[i];
286 for (vsize j = ape->grobs_.size (); j--;)
288 Grob *a = ape->grobs_[j];
291 common[Y_AXIS] = common[Y_AXIS]->common_refpoint (a, Y_AXIS);
295 Grob *head = a->get_parent (Y_AXIS);
297 Grob *col = head->get_parent (X_AXIS);
298 if (Note_column::has_interface (col))
299 note_cols.push_back (col);
301 heads.push_back (head);
306 This is a little kludgy: to get all notes, we look if there are
309 for (vsize i = note_cols.size (); i--;)
311 Grob *c = note_cols[i]->get_parent (X_AXIS);
312 if (Note_collision_interface::has_interface (c))
314 extract_grob_set (c, "elements", gs);
316 concat (note_cols, gs);
320 for (vsize i = note_cols.size (); i--;)
321 concat (heads, extract_grob_array (note_cols[i], "note-heads"));
323 vector_sort (heads, less<Grob*> ());
326 vector<Grob *> stems;
327 for (vsize i = 0; i < heads.size (); i++)
329 if (Grob *s = Rhythmic_head::get_stem (heads[i]))
333 vector_sort (stems, less<Grob*> ());
336 common[Y_AXIS] = common_refpoint_of_array (heads, common[Y_AXIS], Y_AXIS);
337 common[Y_AXIS] = common_refpoint_of_array (stems, common[Y_AXIS], Y_AXIS);
339 for (vsize i = 0; i < heads.size (); i++)
341 if (Grob *s = Rhythmic_head::get_stem (heads[i]))
344 common[Y_AXIS] = s->common_refpoint (common[Y_AXIS], Y_AXIS);
348 vector_sort (stems, less<Grob*> ());
352 for (vsize i = apes.size (); i--;)
354 Accidental_placement_entry *ape = apes[i];
356 for (vsize j = apes[i]->grobs_.size (); j--;)
358 Grob *a = apes[i]->grobs_[j];
359 vector<Box> boxes = Accidental_interface::accurate_boxes (a, common);
361 ape->extents_.insert (ape->extents_.end (), boxes.begin (), boxes.end ());
363 ape->left_skyline_ = Skyline (ape->extents_, 0, Y_AXIS, LEFT);
364 ape->right_skyline_ = Skyline (ape->extents_, 0, Y_AXIS, RIGHT);
368 for (vsize i = apes.size (); i--;)
372 for (vsize j = apes[i]->extents_.size (); j--;)
373 y.unite (apes[i]->extents_[j][Y_AXIS]);
374 apes[i]->vertical_extent_ = y;
377 all_accidental_vertical_extent = total;
378 stagger_apes (&apes);
380 Accidental_placement_entry *head_ape = new Accidental_placement_entry;
381 common[X_AXIS] = common_refpoint_of_array (heads, common[X_AXIS], X_AXIS);
383 vector<Box> head_extents;
384 for (vsize i = heads.size (); i--;)
385 head_extents.push_back (Box (heads[i]->extent (common[X_AXIS], X_AXIS),
386 heads[i]->extent (common[Y_AXIS], Y_AXIS)));
388 for (vsize i = 0; i < stems.size (); i ++)
390 int very_large = INT_MAX;
392 head_extents.push_back (Box (stems[i]->extent (common[X_AXIS], X_AXIS),
393 stems[i]->pure_height (common[Y_AXIS], 0, very_large)));
396 head_ape->left_skyline_ = Skyline (head_extents, 0, Y_AXIS, LEFT);
397 head_ape->offset_ = 0.0;
399 Real padding = robust_scm2double (me->get_property ("padding"), 0.2);
401 Skyline left_skyline = head_ape->left_skyline_;
402 left_skyline.raise (-robust_scm2double (me->get_property ("right-padding"), 0));
405 Add accs entries right-to-left.
407 for (vsize i = apes.size (); i-- > 0;)
409 Real offset = -apes[i]->right_skyline_.distance (left_skyline);
411 offset = (i + 1 < apes.size ()) ? apes[i + 1]->offset_ : 0.0;
415 apes[i]->offset_ = offset;
417 Skyline new_left_skyline = apes[i]->left_skyline_;
418 new_left_skyline.raise (apes[i]->offset_);
419 new_left_skyline.merge (left_skyline);
420 left_skyline = new_left_skyline;
423 for (vsize i = apes.size (); i--;)
425 Accidental_placement_entry *ape = apes[i];
426 for (vsize j = ape->grobs_.size (); j--;)
427 ape->grobs_[j]->translate_axis (ape->offset_, X_AXIS);
430 Interval left_extent, right_extent;
431 Accidental_placement_entry *ape = apes[0];
433 for (vsize i = ape->extents_.size (); i--;)
434 left_extent.unite (ape->offset_ + ape->extents_[i][X_AXIS]);
437 for (vsize i = ape->extents_.size (); i--;)
438 right_extent.unite (ape->offset_ + ape->extents_[i][X_AXIS]);
440 left_extent[LEFT] -= robust_scm2double (me->get_property ("left-padding"), 0);
441 Interval width (left_extent[LEFT], right_extent[RIGHT]);
443 SCM scm_width = ly_interval2scm (width);
444 me->flush_extent_cache (X_AXIS);
445 me->set_property ("X-extent", scm_width);
447 junk_pointers (apes);
454 ADD_INTERFACE (Accidental_placement,
455 "Resolve accidental collisions.",