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 Accidental_placement_entry ()
115 static Interval all_accidental_vertical_extent;
116 Real ape_priority (Accidental_placement_entry const *a)
118 return a->vertical_extent_[UP];
121 int ape_compare (Accidental_placement_entry *const &a,
122 Accidental_placement_entry *const &b)
124 return sign (ape_priority (a) - ape_priority (b));
127 bool ape_less (Accidental_placement_entry *const &a,
128 Accidental_placement_entry *const &b)
130 return ape_priority (a) < ape_priority (b);
133 int ape_rcompare (Accidental_placement_entry *const &a,
134 Accidental_placement_entry *const &b)
136 return -sign (ape_priority (a) - ape_priority (b));
148 stagger_apes (vector<Accidental_placement_entry*> *apes)
150 vector<Accidental_placement_entry*> asc = *apes;
152 vector_sort (asc, &ape_less);
157 for (vsize i = 0; i < asc.size ();)
159 Accidental_placement_entry *a = 0;
176 set_ape_skylines (Accidental_placement_entry *ape,
179 for (vsize j = ape->grobs_.size (); j--;)
181 Grob *a = ape->grobs_[j];
182 vector<Box> boxes = Accidental_interface::accurate_boxes (a, common);
183 ape->extents_.insert (ape->extents_.end (), boxes.begin (), boxes.end ());
185 ape->left_skyline_ = Skyline (ape->extents_, 0, Y_AXIS, LEFT);
186 ape->right_skyline_ = Skyline (ape->extents_, 0, Y_AXIS, RIGHT);
190 extract_heads_and_stems (vector<Accidental_placement_entry*> const &apes)
192 vector<Grob*> note_cols;
195 for (vsize i = apes.size (); i--;)
197 Accidental_placement_entry *ape = apes[i];
198 for (vsize j = ape->grobs_.size (); j--;)
200 Grob *acc = ape->grobs_[j];
201 Grob *head = acc->get_parent (Y_AXIS);
202 Grob *col = head->get_parent (X_AXIS);
204 if (Note_column::has_interface (col))
205 note_cols.push_back (col);
207 ret.push_back (head);
212 This is a little kludgy: in case there are note columns without
213 accidentals, we get them from the Note_collision objects.
215 for (vsize i = note_cols.size (); i--;)
217 Grob *c = note_cols[i]->get_parent (X_AXIS);
218 if (Note_collision_interface::has_interface (c))
220 extract_grob_set (c, "elements", columns);
221 concat (note_cols, columns);
225 /* Now that we have all of the columns, grab all of the note-heads */
226 for (vsize i = note_cols.size (); i--;)
227 concat (ret, extract_grob_array (note_cols[i], "note-heads"));
229 /* Now that we have all of the heads, grab all of the stems */
230 for (vsize i = ret.size (); i--;)
231 if (Grob *s = Rhythmic_head::get_stem (ret[i]))
235 vector_sort (ret, less<Grob*> ());
241 common_refpoint_of_accidentals (vector<Accidental_placement_entry*> const &apes, Axis a)
245 for (vsize i = apes.size (); i--;)
246 for (vsize j = apes[i]->grobs_.size (); j--;)
249 ret = apes[i]->grobs_[j];
251 ret = ret->common_refpoint (apes[i]->grobs_[j], a);
259 This routine computes placements of accidentals. During
260 add_accidental (), accidentals are already grouped by note, so that
261 octaves are placed above each other; they form columns. Then the
262 columns are sorted: the biggest columns go closest to the note.
263 Then the columns are spaced as closely as possible (using skyline
267 TODO: more advanced placement. Typically, the accs should be placed
268 to form a C shape, like this
277 The naturals should be left of the C as well; they should
280 Note that this placement problem looks NP hard, so we just use a
281 simple strategy, not an optimal choice.
285 TODO: there should be more space in the following situation
299 MAKE_SCHEME_CALLBACK (Accidental_placement, calc_positioning_done, 1);
301 Accidental_placement::calc_positioning_done (SCM smob)
303 Grob *me = unsmob_grob (smob);
307 me->set_property ("positioning-done", SCM_BOOL_T);
309 SCM accs = me->get_object ("accidental-grobs");
310 if (!scm_is_pair (accs))
313 vector<Accidental_placement_entry*> apes;
314 for (SCM s = accs; scm_is_pair (s); s = scm_cdr (s))
316 Accidental_placement_entry *ape = new Accidental_placement_entry;
317 ape->notename_ = scm_to_int (scm_caar (s));
319 for (SCM t = scm_cdar (s); scm_is_pair (t); t = scm_cdr (t))
320 ape->grobs_.push_back (unsmob_grob (scm_car (t)));
322 apes.push_back (ape);
325 Grob *common[] = {me, 0};
327 vector<Grob*> heads_and_stems = extract_heads_and_stems (apes);
329 common[Y_AXIS] = common_refpoint_of_accidentals (apes, Y_AXIS);
330 common[Y_AXIS] = common_refpoint_of_array (heads_and_stems, common[Y_AXIS], Y_AXIS);
331 common[X_AXIS] = common_refpoint_of_array (heads_and_stems, me, X_AXIS);
333 for (vsize i = apes.size (); i--;)
334 set_ape_skylines (apes[i], common);
337 for (vsize i = apes.size (); i--;)
341 for (vsize j = apes[i]->extents_.size (); j--;)
342 y.unite (apes[i]->extents_[j][Y_AXIS]);
343 apes[i]->vertical_extent_ = y;
346 all_accidental_vertical_extent = total;
347 stagger_apes (&apes);
349 Accidental_placement_entry *head_ape = new Accidental_placement_entry;
351 vector<Box> head_extents;
352 for (vsize i = heads_and_stems.size (); i--;)
353 head_extents.push_back (Box (heads_and_stems[i]->extent (common[X_AXIS], X_AXIS),
354 heads_and_stems[i]->pure_height (common[Y_AXIS], 0, INT_MAX)));
356 head_ape->left_skyline_ = Skyline (head_extents, 0, Y_AXIS, LEFT);
357 head_ape->offset_ = 0.0;
359 Real padding = robust_scm2double (me->get_property ("padding"), 0.2);
361 Skyline left_skyline = head_ape->left_skyline_;
362 left_skyline.raise (-robust_scm2double (me->get_property ("right-padding"), 0));
365 Add accs entries right-to-left.
367 for (vsize i = apes.size (); i-- > 0;)
369 Real offset = -apes[i]->right_skyline_.distance (left_skyline);
371 offset = (i + 1 < apes.size ()) ? apes[i + 1]->offset_ : 0.0;
375 apes[i]->offset_ = offset;
377 Skyline new_left_skyline = apes[i]->left_skyline_;
378 new_left_skyline.raise (apes[i]->offset_);
379 new_left_skyline.merge (left_skyline);
380 left_skyline = new_left_skyline;
383 for (vsize i = apes.size (); i--;)
385 Accidental_placement_entry *ape = apes[i];
386 for (vsize j = ape->grobs_.size (); j--;)
387 ape->grobs_[j]->translate_axis (ape->offset_, X_AXIS);
390 Interval left_extent, right_extent;
391 Accidental_placement_entry *ape = apes[0];
393 for (vsize i = ape->extents_.size (); i--;)
394 left_extent.unite (ape->offset_ + ape->extents_[i][X_AXIS]);
397 for (vsize i = ape->extents_.size (); i--;)
398 right_extent.unite (ape->offset_ + ape->extents_[i][X_AXIS]);
400 left_extent[LEFT] -= robust_scm2double (me->get_property ("left-padding"), 0);
401 Interval width (left_extent[LEFT], right_extent[RIGHT]);
403 SCM scm_width = ly_interval2scm (width);
404 me->flush_extent_cache (X_AXIS);
405 me->set_property ("X-extent", scm_width);
407 junk_pointers (apes);
414 ADD_INTERFACE (Accidental_placement,
415 "Resolve accidental collisions.",