2 accidental-placement.cc -- implement Accidental_placement
4 source file of the GNU LilyPond music typesetter
6 (c) 2002--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
10 #include "accidental-placement.hh"
12 #include "accidental-interface.hh"
14 #include "note-collision.hh"
15 #include "note-column.hh"
17 #include "pointer-group-interface.hh"
19 #include "stream-event.hh"
24 Accidental_placement::add_accidental (Grob *me, Grob *a)
26 a->set_parent (me, X_AXIS);
27 a->set_property ("X-offset", Grob::x_parent_positioning_proc);
28 SCM cause = a->get_parent (Y_AXIS)->get_property ("cause");
30 Stream_event *mcause = unsmob_stream_event (cause);
33 programming_error ("note head has no event cause");
37 Pitch *p = unsmob_pitch (mcause->get_property ("pitch"));
39 int n = p->get_notename ();
41 SCM accs = me->get_object ("accidental-grobs");
42 SCM key = scm_from_int (n);
43 SCM entry = scm_assq (key, accs);
44 if (entry == SCM_BOOL_F)
47 entry = scm_cdr (entry);
49 entry = scm_cons (a->self_scm (), entry);
51 accs = scm_assq_set_x (accs, key, entry);
53 me->set_object ("accidental-grobs", accs);
57 Split into break reminders.
60 Accidental_placement::split_accidentals (Grob *accs,
61 vector<Grob*> *break_reminder,
62 vector<Grob*> *real_acc)
64 for (SCM acs = accs->get_object ("accidental-grobs"); scm_is_pair (acs);
66 for (SCM s = scm_cdar (acs); scm_is_pair (s); s = scm_cdr (s))
68 Grob *a = unsmob_grob (scm_car (s));
70 if (unsmob_grob (a->get_object ("tie")))
71 break_reminder->push_back (a);
73 real_acc->push_back (a);
78 Accidentals are special, because they appear and disappear after
82 Accidental_placement::get_relevant_accidental_extent (Grob *me,
87 vector<Grob*> *which = 0;
89 Accidental_placement::split_accidentals (me, &br, &ra);
92 if (dynamic_cast<Item *> (left_object)->break_status_dir () == RIGHT)
98 for (vsize i = 0; i < which->size (); i++)
99 extent.unite (which->at (i)->extent (item_col, X_AXIS));
101 if (!extent.is_empty ())
103 Real p = robust_scm2double (me->get_property ("left-padding"), 0.2);
110 struct Accidental_placement_entry
112 vector<Skyline_entry> left_skyline_;
113 vector<Skyline_entry> right_skyline_;
114 Interval vertical_extent_;
115 vector<Box> extents_;
116 vector<Grob*> grobs_;
119 Accidental_placement_entry ()
126 static Interval all_accidental_vertical_extent;
127 Real ape_priority (Accidental_placement_entry const *a)
129 return a->vertical_extent_[UP];
132 int ape_compare (Accidental_placement_entry *const &a,
133 Accidental_placement_entry *const &b)
135 return sign (ape_priority (a) - ape_priority (b));
138 bool ape_less (Accidental_placement_entry *const &a,
139 Accidental_placement_entry *const &b)
141 return ape_priority (a) < ape_priority (b);
144 int ape_rcompare (Accidental_placement_entry *const &a,
145 Accidental_placement_entry *const &b)
147 return -sign (ape_priority (a) - ape_priority (b));
159 stagger_apes (vector<Accidental_placement_entry*> *apes)
161 vector<Accidental_placement_entry*> asc = *apes;
163 vector_sort (asc, &ape_less);
168 for (vsize i = 0; i < asc.size ();)
170 Accidental_placement_entry *a = 0;
187 This routine computes placements of accidentals. During
188 add_accidental (), accidentals are already grouped by note, so that
189 octaves are placed above each other; they form columns. Then the
190 columns are sorted: the biggest columns go closest to the note.
191 Then the columns are spaced as closely as possible (using skyline
195 TODO: more advanced placement. Typically, the accs should be placed
196 to form a C shape, like this
205 The naturals should be left of the C as well; they should
208 Note that this placement problem looks NP hard, so we just use a
209 simple strategy, not an optimal choice.
213 TODO: there should be more space in the following situation
227 MAKE_SCHEME_CALLBACK(Accidental_placement, calc_positioning_done, 1);
229 Accidental_placement::calc_positioning_done (SCM smob)
231 Grob *me = unsmob_grob (smob);
235 SCM accs = me->get_object ("accidental-grobs");
236 if (!scm_is_pair (accs))
240 TODO: there is a bug in this code. If two accs are on the same
241 Y-position, they share an Ape, and will be printed in overstrike.
243 vector<Accidental_placement_entry*> apes;
244 for (SCM s = accs; scm_is_pair (s); s = scm_cdr (s))
246 Accidental_placement_entry *ape = new Accidental_placement_entry;
247 ape->notename_ = scm_to_int (scm_caar (s));
249 for (SCM t = scm_cdar (s); scm_is_pair (t); t = scm_cdr (t))
250 ape->grobs_.push_back (unsmob_grob (scm_car (t)));
252 apes.push_back (ape);
255 Grob *common[] = {me, 0};
258 First we must extract *all* pointers. We can only determine
259 extents if we're sure that we've found the right common refpoint
261 vector<Grob*> note_cols, heads;
262 for (vsize i = apes.size (); i--;)
264 Accidental_placement_entry *ape = apes[i];
265 for (vsize j = ape->grobs_.size (); j--;)
267 Grob *a = ape->grobs_[j];
270 common[Y_AXIS] = common[Y_AXIS]->common_refpoint (a, Y_AXIS);
274 Grob *head = a->get_parent (Y_AXIS);
276 Grob *col = head->get_parent (X_AXIS);
277 if (Note_column::has_interface (col))
278 note_cols.push_back (col);
280 heads.push_back (head);
285 This is a little kludgy: to get all notes, we look if there are
288 for (vsize i = note_cols.size (); i--;)
290 Grob *c = note_cols[i]->get_parent (X_AXIS);
291 if (Note_collision_interface::has_interface (c))
293 extract_grob_set (c, "elements", gs);
295 concat (note_cols, gs);
299 for (vsize i = note_cols.size (); i--;)
300 concat (heads, extract_grob_array (note_cols[i], "note-heads"));
302 vector_sort (heads, less<Grob*> ());
304 common[Y_AXIS] = common_refpoint_of_array (heads, common[Y_AXIS], Y_AXIS);
306 for (vsize i = apes.size (); i--;)
308 Accidental_placement_entry *ape = apes[i];
309 ape->left_skyline_ = empty_skyline (LEFT);
310 ape->right_skyline_ = empty_skyline (RIGHT);
312 for (vsize j = apes[i]->grobs_.size (); j--;)
314 Grob *a = apes[i]->grobs_[j];
316 vector<Box> boxes = Accidental_interface::accurate_boxes (a, common);
318 ape->extents_.insert (ape->extents_.end (), boxes.begin (), boxes.end ());
319 for (vsize j = boxes.size (); j--;)
321 insert_extent_into_skyline (&ape->left_skyline_, boxes[j], Y_AXIS, LEFT);
322 insert_extent_into_skyline (&ape->right_skyline_, boxes[j], Y_AXIS, RIGHT);
328 for (vsize i = apes.size (); i--;)
332 for (vsize j = apes[i]->extents_.size (); j--;)
333 y.unite (apes[i]->extents_[j][Y_AXIS]);
334 apes[i]->vertical_extent_ = y;
337 all_accidental_vertical_extent = total;
338 stagger_apes (&apes);
340 Accidental_placement_entry *head_ape = new Accidental_placement_entry;
341 common[X_AXIS] = common_refpoint_of_array (heads, common[X_AXIS], X_AXIS);
342 vector<Skyline_entry> head_skyline (empty_skyline (LEFT));
343 vector<Box> head_extents;
344 for (vsize i = heads.size (); i--;)
346 Box b (heads[i]->extent (common[X_AXIS], X_AXIS),
347 heads[i]->extent (common[Y_AXIS], Y_AXIS));
349 insert_extent_into_skyline (&head_skyline, b, Y_AXIS, LEFT);
352 head_ape->left_skyline_ = head_skyline;
353 head_ape->offset_ = 0.0;
355 Real padding = robust_scm2double (me->get_property ("padding"), 0.2);
357 vector<Skyline_entry> left_skyline = head_ape->left_skyline_;
358 heighten_skyline (&left_skyline,
359 -robust_scm2double (me->get_property ("right-padding"), 0));
361 Add accs entries right-to-left.
363 for (vsize i = apes.size (); i-- > 0;)
366 = -skyline_meshing_distance (apes[i]->right_skyline_, left_skyline);
368 offset = (i < apes.size () - 1) ? apes[i + 1]->offset_ : 0.0;
372 apes[i]->offset_ = offset;
374 vector<Skyline_entry> new_left_skyline = apes[i]->left_skyline_;
375 heighten_skyline (&new_left_skyline, apes[i]->offset_);
376 merge_skyline (&new_left_skyline, left_skyline, LEFT);
377 left_skyline = new_left_skyline;
380 for (vsize i = apes.size (); i--;)
382 Accidental_placement_entry *ape = apes[i];
383 for (vsize j = ape->grobs_.size (); j--;)
384 ape->grobs_[j]->translate_axis (ape->offset_, X_AXIS);
387 Interval left_extent, right_extent;
388 Accidental_placement_entry *ape = apes[0];
390 for (vsize i = ape->extents_.size (); i--;)
391 left_extent.unite (ape->offset_ + ape->extents_[i][X_AXIS]);
394 for (vsize i = ape->extents_.size (); i--;)
395 right_extent.unite (ape->offset_ + ape->extents_[i][X_AXIS]);
397 left_extent[LEFT] -= robust_scm2double (me->get_property ("left-padding"), 0);
398 Interval width (left_extent[LEFT], right_extent[RIGHT]);
400 SCM scm_width = ly_interval2scm (width);
401 me->flush_extent_cache (X_AXIS);
402 me->set_property ("X-extent", scm_width);
404 for (vsize i = apes.size (); i--;)
410 ADD_INTERFACE (Accidental_placement,
411 "accidental-placement-interface",
412 "Resolve accidental collisions.",