2 accidental-placement.cc -- implement Accidental_placement
4 source file of the GNU LilyPond music typesetter
6 (c) 2002--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
13 #include "accidental-placement.hh"
14 #include "libc-extension.hh" // isinf
19 #include "note-column.hh"
20 #include "group-interface.hh"
21 #include "note-collision.hh"
22 #include "accidental-interface.hh"
24 MAKE_SCHEME_CALLBACK (Accidental_placement, alignment_callback, 2);
26 Accidental_placement::alignment_callback (SCM s, SCM )
28 Grob * me = unsmob_grob (s);
30 Grob * par = me->get_parent (X_AXIS);
31 if (!to_boolean (par->get_property ("positioning-done")))
33 par->set_property ("positioning-done", SCM_BOOL_T);
34 position_accidentals (par);
37 return scm_int2num (0);
42 Accidental_placement::add_accidental (Grob* me, Grob* a)
44 a->set_parent (me, X_AXIS);
45 a->add_offset_callback (alignment_callback_proc, X_AXIS);
46 SCM cause = a->get_parent (Y_AXIS)->get_property ("cause");
48 Music *mcause = unsmob_music (cause);
51 programming_error ("Note head has no music cause!");
55 Pitch *p = unsmob_pitch (mcause->get_property ("pitch"));
57 int n = p->get_notename ();
59 SCM accs = me->get_property ("accidental-grobs");
60 SCM key = scm_int2num (n);
61 SCM entry = scm_assq (key, accs);
62 if (entry == SCM_BOOL_F)
67 entry = scm_cdr (entry);
69 entry = scm_cons (a->self_scm (), entry);
71 accs = scm_assq_set_x (accs, key, entry);
73 me->set_property ("accidental-grobs", accs);
77 Split into break reminders.
80 Accidental_placement::split_accidentals (Grob * accs,
81 Link_array<Grob> *break_reminder,
82 Link_array<Grob> *real_acc)
84 for (SCM acs = accs->get_property ("accidental-grobs"); scm_is_pair (acs);
86 for (SCM s = scm_cdar (acs); scm_is_pair (s); s = scm_cdr (s))
88 Grob *a = unsmob_grob (scm_car (s));
90 if (unsmob_grob (a->get_property ("tie")))
91 break_reminder->push (a);
98 Accidentals are special, because they appear and disappear after
102 Accidental_placement::get_relevant_accidental_extent (Grob *me,
106 Link_array<Grob> br, ra;
107 Link_array<Grob> *which = 0;
109 Accidental_placement::split_accidentals (me, &br, &ra);
112 if (dynamic_cast<Item*>(left_object)->break_status_dir () == RIGHT)
118 for (int i = 0; i < which->size (); i++)
120 extent.unite (which->elem (i)->extent (item_col, X_AXIS));
123 if (!extent.is_empty ())
125 Real p = robust_scm2double (me->get_property ("left-padding"), 0.2);
134 struct Accidental_placement_entry
136 Array<Skyline_entry> left_skyline_;
137 Array<Skyline_entry> right_skyline_;
138 Interval vertical_extent_;
140 Link_array<Grob> grobs_;
143 Accidental_placement_entry ()
150 static Interval all_accidental_vertical_extent;
151 Real ape_priority (Accidental_placement_entry const * a)
153 return a->vertical_extent_[UP];
158 int ape_compare (Accidental_placement_entry *const &a,
159 Accidental_placement_entry *const &b)
161 return sign (ape_priority (a) - ape_priority (b));
164 int ape_rcompare (Accidental_placement_entry *const &a,
165 Accidental_placement_entry *const &b)
167 return -sign (ape_priority (a) - ape_priority (b));
182 stagger_apes (Link_array<Accidental_placement_entry> *apes)
184 Link_array<Accidental_placement_entry> asc = *apes;
187 asc.sort (&ape_compare);
193 while (i < asc.size ())
195 Accidental_placement_entry * a = 0;
212 This routine computes placements of accidentals. During
213 add_accidental (), accidentals are already grouped by note, so that
214 octaves are placed above each other; they form columns. Then the
215 columns are sorted: the biggest columns go closest to the note.
216 Then the columns are spaced as closely as possible (using skyline
220 TODO: more advanced placement. Typically, the accs should be placed
221 to form a C shape, like this
230 The naturals should be left of the C as well; they should
233 Note that this placement problem looks NP hard, so we just use a
234 simple strategy, not an optimal choice.
239 TODO: there should be more space in the following situation
251 Accidental_placement::position_accidentals (Grob * me)
254 return SCM_UNSPECIFIED;
256 SCM accs = me->get_property ("accidental-grobs");
257 if (!scm_is_pair (accs))
258 return SCM_UNSPECIFIED;
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 Link_array<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 (unsmob_grob (scm_car (t)));
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 Link_array<Grob> note_cols, heads;
283 for (int i = apes.size (); i--;)
285 Accidental_placement_entry * ape = apes[i];
286 for (int 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 (col);
306 This is a little kludgy: to get all notes, we look if there are
309 for (int i = note_cols.size () ; i--;)
311 Grob *c = note_cols[i]->get_parent (X_AXIS);
312 if (Note_collision_interface::has_interface (c))
314 Link_array<Grob> gs =
315 extract_grob_array (c, ly_symbol2scm ("elements"));
317 note_cols.concat (gs);
321 for (int i = note_cols.size () ; i--;)
323 heads.concat (extract_grob_array (note_cols[i], ly_symbol2scm ("note-heads")));
325 heads.default_sort ();
327 common[Y_AXIS] = common_refpoint_of_array (heads, common[Y_AXIS], Y_AXIS);
330 for (int i = apes.size (); i--;)
332 Accidental_placement_entry * ape = apes[i];
333 ape->left_skyline_ = empty_skyline (LEFT);
334 ape->right_skyline_ = empty_skyline (RIGHT);
336 for (int j = apes[i]->grobs_.size (); j--;)
338 Grob * a = apes[i]->grobs_[j];
340 Array<Box> boxes = Accidental_interface::accurate_boxes (a, common);
342 ape->extents_.concat (boxes);
343 for (int j = boxes.size (); j--;)
345 insert_extent_into_skyline (&ape->left_skyline_, boxes[j], Y_AXIS, LEFT);
346 insert_extent_into_skyline (&ape->right_skyline_ , boxes[j], Y_AXIS, RIGHT);
353 for (int i = apes.size (); i--;)
357 for (int j = apes[i]->extents_.size (); j--;)
359 y.unite (apes[i]->extents_[j][Y_AXIS]);
361 apes[i]->vertical_extent_ = y;
364 all_accidental_vertical_extent = total;
365 stagger_apes (&apes);
367 Accidental_placement_entry * head_ape = new Accidental_placement_entry;
368 common[X_AXIS] = common_refpoint_of_array (heads, common[X_AXIS], X_AXIS);
369 Array<Skyline_entry> head_skyline (empty_skyline (LEFT));
370 Array<Box> head_extents;
371 for (int i = heads.size (); i--;)
373 Box b (heads[i]->extent (common[X_AXIS] , X_AXIS),
374 heads[i]->extent (common[Y_AXIS], Y_AXIS));
376 insert_extent_into_skyline (&head_skyline, b , Y_AXIS, LEFT);
379 head_ape-> left_skyline_ = head_skyline;
380 head_ape->offset_ = 0.0;
382 Real padding = robust_scm2double (me->get_property ("padding"), 0.2);
384 Array<Skyline_entry> left_skyline = head_ape->left_skyline_;
385 heighten_skyline (&left_skyline,
386 -robust_scm2double (me->get_property ("right-padding"), 0));
388 Add accs entries right-to-left.
390 for (int i = apes.size (); i-- > 0;)
393 -skyline_meshing_distance (apes[i]->right_skyline_, left_skyline);
395 offset = (i < apes.size () - 1) ? apes[i+1]->offset_ : 0.0;
399 apes[i]->offset_ = offset;
401 Array<Skyline_entry> new_left_skyline = apes[i]->left_skyline_;
402 heighten_skyline (&new_left_skyline, apes[i]->offset_);
403 merge_skyline (&new_left_skyline, left_skyline, LEFT);
404 left_skyline = new_left_skyline;
407 for (int i = apes.size (); i--;)
409 Accidental_placement_entry* ape = apes[i];
410 for (int j = ape->grobs_.size (); j--;)
412 ape->grobs_[j]->translate_axis (ape->offset_, X_AXIS);
417 Interval left_extent, right_extent;
418 Accidental_placement_entry *ape = apes[0];
420 for (int i = ape->extents_.size (); i--;)
421 left_extent.unite (ape->offset_ + ape->extents_[i][X_AXIS]);
424 for (int i = ape->extents_.size (); i--;)
425 right_extent.unite (ape->offset_ + ape->extents_[i][X_AXIS]);
428 left_extent[LEFT] -= robust_scm2double (me->get_property ("left-padding"), 0);
429 Interval width (left_extent[LEFT], right_extent[RIGHT]);
431 SCM scm_width = ly_interval2scm (width);
432 me->set_extent (scm_width, X_AXIS);
434 for (int i = apes.size (); i--;)
437 return SCM_UNSPECIFIED;
440 ADD_INTERFACE (Accidental_placement,
441 "accidental-placement-interface",
442 "Resolve accidental collisions.",
443 "left-padding padding right-padding accidental-grobs positioning-done")