]> git.donarmstrong.com Git - lilypond.git/blob - lily/accidental-placement.cc
* flower/include/std-vector.hh
[lilypond.git] / lily / accidental-placement.cc
1 /*
2   accidental-placement.cc -- implement Accidental_placement
3
4   source file of the GNU LilyPond music typesetter
5
6   (c) 2002--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
7 */
8
9
10
11 #include "accidental-placement.hh"
12 #include "skyline.hh"
13 #include "music.hh"
14 #include "pitch.hh"
15 #include "warn.hh"
16 #include "note-column.hh"
17 #include "pointer-group-interface.hh"
18 #include "note-collision.hh"
19 #include "accidental-interface.hh"
20
21
22 void
23 Accidental_placement::add_accidental (Grob *me, Grob *a)
24 {
25   a->set_parent (me, X_AXIS);
26   a->set_property ("X-offset", Grob::x_parent_positioning_proc);
27   SCM cause = a->get_parent (Y_AXIS)->get_property ("cause");
28
29   Music *mcause = unsmob_music (cause);
30   if (!mcause)
31     {
32       programming_error ("note head has no music cause");
33       return;
34     }
35
36   Pitch *p = unsmob_pitch (mcause->get_property ("pitch"));
37
38   int n = p->get_notename ();
39
40   SCM accs = me->get_object ("accidental-grobs");
41   SCM key = scm_from_int (n);
42   SCM entry = scm_assq (key, accs);
43   if (entry == SCM_BOOL_F)
44     entry = SCM_EOL;
45   else
46     entry = scm_cdr (entry);
47
48   entry = scm_cons (a->self_scm (), entry);
49
50   accs = scm_assq_set_x (accs, key, entry);
51
52   me->set_object ("accidental-grobs", accs);
53 }
54
55 /*
56   Split into break reminders.
57 */
58 void
59 Accidental_placement::split_accidentals (Grob *accs,
60                                          Link_array<Grob> *break_reminder,
61                                          Link_array<Grob> *real_acc)
62 {
63   for (SCM acs = accs->get_object ("accidental-grobs"); scm_is_pair (acs);
64        acs = scm_cdr (acs))
65     for (SCM s = scm_cdar (acs); scm_is_pair (s); s = scm_cdr (s))
66       {
67         Grob *a = unsmob_grob (scm_car (s));
68
69         if (unsmob_grob (a->get_object ("tie")))
70           break_reminder->push_back (a);
71         else
72           real_acc->push_back (a);
73       }
74 }
75
76 /*
77   Accidentals are special, because they appear and disappear after
78   ties at will.
79 */
80 Interval
81 Accidental_placement::get_relevant_accidental_extent (Grob *me,
82                                                       Item *item_col,
83                                                       Grob *left_object)
84 {
85   Link_array<Grob> br, ra;
86   Link_array<Grob> *which = 0;
87
88   Accidental_placement::split_accidentals (me, &br, &ra);
89   br.concat (ra);
90
91   if (dynamic_cast<Item *> (left_object)->break_status_dir () == RIGHT)
92     which = &br;
93   else
94     which = &ra;
95
96   Interval extent;
97   for (vsize i = 0; i < which->size (); i++)
98     extent.unite (which->at (i)->extent (item_col, X_AXIS));
99
100   if (!extent.is_empty ())
101     {
102       Real p = robust_scm2double (me->get_property ("left-padding"), 0.2);
103       extent[LEFT] -= p;
104     }
105
106   return extent;
107 }
108
109 struct Accidental_placement_entry
110 {
111   std::vector<Skyline_entry> left_skyline_;
112   std::vector<Skyline_entry> right_skyline_;
113   Interval vertical_extent_;
114   std::vector<Box> extents_;
115   Link_array<Grob> grobs_;
116   Real offset_;
117   int notename_;
118   Accidental_placement_entry ()
119   {
120     offset_ = 0.0;
121     notename_ = -1;
122   }
123 };
124
125 static Interval all_accidental_vertical_extent;
126 Real ape_priority (Accidental_placement_entry const *a)
127 {
128   return a->vertical_extent_[UP];
129 }
130
131 int ape_compare (Accidental_placement_entry *const &a,
132                  Accidental_placement_entry *const &b)
133 {
134   return sign (ape_priority (a) - ape_priority (b));
135 }
136
137 int ape_rcompare (Accidental_placement_entry *const &a,
138                   Accidental_placement_entry *const &b)
139 {
140   return -sign (ape_priority (a) - ape_priority (b));
141 }
142
143 /*
144   TODO: should favor
145
146   b
147   b
148
149   placement
150 */
151 void
152 stagger_apes (Link_array<Accidental_placement_entry> *apes)
153 {
154   Link_array<Accidental_placement_entry> asc = *apes;
155
156   asc.sort (&ape_compare);
157
158   apes->clear ();
159
160   int parity = 1;
161   for (vsize i = 0; i < asc.size ();)
162     {
163       Accidental_placement_entry *a = 0;
164       if (parity)
165         a = asc.pop ();
166       else
167         a = asc[i++];
168
169       apes->push_back (a);
170       parity = !parity;
171     }
172
173   apes->reverse ();
174 }
175
176 /*
177   This routine computes placements of accidentals. During
178   add_accidental (), accidentals are already grouped by note, so that
179   octaves are placed above each other; they form columns. Then the
180   columns are sorted: the biggest columns go closest to the note.
181   Then the columns are spaced as closely as possible (using skyline
182   spacing).
183
184
185   TODO: more advanced placement. Typically, the accs should be placed
186   to form a C shape, like this
187
188
189   ##
190   b b
191   # #
192   b
193   b b
194
195   The naturals should be left of the C as well; they should
196   be separate accs.
197
198   Note that this placement problem looks NP hard, so we just use a
199   simple strategy, not an optimal choice.
200 */
201
202 /*
203   TODO: there should be more space in the following situation
204
205
206   Natural + downstem
207
208   *
209   *  |_
210   *  | |    X
211   *  |_|   |
212   *    |   |
213   *
214
215 */
216
217 MAKE_SCHEME_CALLBACK(Accidental_placement, calc_positioning_done, 1);
218 SCM
219 Accidental_placement::calc_positioning_done (SCM smob)
220 {
221   Grob *me = unsmob_grob (smob);
222   if (!me->is_live ())
223     return SCM_BOOL_T;
224
225   SCM accs = me->get_object ("accidental-grobs");
226   if (!scm_is_pair (accs))
227     return SCM_BOOL_T;
228
229   /*
230     TODO: there is a bug in this code. If two accs are on the same
231     Y-position, they share an Ape, and will be printed in overstrike.
232   */
233   Link_array<Accidental_placement_entry> apes;
234   for (SCM s = accs; scm_is_pair (s); s = scm_cdr (s))
235     {
236       Accidental_placement_entry *ape = new Accidental_placement_entry;
237       ape->notename_ = scm_to_int (scm_caar (s));
238
239       for (SCM t = scm_cdar (s); scm_is_pair (t); t = scm_cdr (t))
240         ape->grobs_.push_back (unsmob_grob (scm_car (t)));
241
242       apes.push_back (ape);
243     }
244
245   Grob *common[] = {me, 0};
246
247   /*
248     First we must extract *all* pointers. We can only determine
249     extents if we're sure that we've found the right common refpoint
250   */
251   Link_array<Grob> note_cols, heads;
252   for (vsize i = apes.size (); i--;)
253     {
254       Accidental_placement_entry *ape = apes[i];
255       for (vsize j = ape->grobs_.size (); j--;)
256         {
257           Grob *a = ape->grobs_[j];
258
259           if (common[Y_AXIS])
260             common[Y_AXIS] = common[Y_AXIS]->common_refpoint (a, Y_AXIS);
261           else
262             common[Y_AXIS] = a;
263
264           Grob *head = a->get_parent (Y_AXIS);
265
266           Grob *col = head->get_parent (X_AXIS);
267           if (Note_column::has_interface (col))
268             note_cols.push_back (col);
269           else
270             heads.push_back (head);
271         }
272     }
273
274   /*
275     This is a little kludgy: to get all notes, we look if there are
276     collisions as well.
277   */
278   for (vsize i = note_cols.size (); i--;)
279     {
280       Grob *c = note_cols[i]->get_parent (X_AXIS);
281       if (Note_collision_interface::has_interface (c))
282         {
283           extract_grob_set (c, "elements", gs);
284
285           note_cols.concat (gs);
286         }
287     }
288
289   for (vsize i = note_cols.size (); i--;)
290     heads.concat (extract_grob_array (note_cols[i], "note-heads"));
291
292   heads.default_sort ();
293   heads.uniq ();
294   common[Y_AXIS] = common_refpoint_of_array (heads, common[Y_AXIS], Y_AXIS);
295
296   for (vsize i = apes.size (); i--;)
297     {
298       Accidental_placement_entry *ape = apes[i];
299       ape->left_skyline_ = empty_skyline (LEFT);
300       ape->right_skyline_ = empty_skyline (RIGHT);
301
302       for (vsize j = apes[i]->grobs_.size (); j--;)
303         {
304           Grob *a = apes[i]->grobs_[j];
305
306           std::vector<Box> boxes = Accidental_interface::accurate_boxes (a, common);
307
308           ape->extents_.concat (boxes);
309           for (vsize j = boxes.size (); j--;)
310             {
311               insert_extent_into_skyline (&ape->left_skyline_, boxes[j], Y_AXIS, LEFT);
312               insert_extent_into_skyline (&ape->right_skyline_, boxes[j], Y_AXIS, RIGHT);
313             }
314         }
315     }
316
317   Interval total;
318   for (vsize i = apes.size (); i--;)
319     {
320       Interval y;
321
322       for (vsize j = apes[i]->extents_.size (); j--;)
323         y.unite (apes[i]->extents_[j][Y_AXIS]);
324       apes[i]->vertical_extent_ = y;
325       total.unite (y);
326     }
327   all_accidental_vertical_extent = total;
328   stagger_apes (&apes);
329
330   Accidental_placement_entry *head_ape = new Accidental_placement_entry;
331   common[X_AXIS] = common_refpoint_of_array (heads, common[X_AXIS], X_AXIS);
332   std::vector<Skyline_entry> head_skyline (empty_skyline (LEFT));
333   std::vector<Box> head_extents;
334   for (vsize i = heads.size (); i--;)
335     {
336       Box b (heads[i]->extent (common[X_AXIS], X_AXIS),
337              heads[i]->extent (common[Y_AXIS], Y_AXIS));
338
339       insert_extent_into_skyline (&head_skyline, b, Y_AXIS, LEFT);
340     }
341
342   head_ape->left_skyline_ = head_skyline;
343   head_ape->offset_ = 0.0;
344
345   Real padding = robust_scm2double (me->get_property ("padding"), 0.2);
346
347   std::vector<Skyline_entry> left_skyline = head_ape->left_skyline_;
348   heighten_skyline (&left_skyline,
349                     -robust_scm2double (me->get_property ("right-padding"), 0));
350   /*
351     Add accs entries right-to-left.
352   */
353   for (vsize i = apes.size (); i-- > 0;)
354     {
355       Real offset
356         = -skyline_meshing_distance (apes[i]->right_skyline_, left_skyline);
357       if (isinf (offset))
358         offset = (i < apes.size () - 1) ? apes[i + 1]->offset_ : 0.0;
359       else
360         offset -= padding;
361
362       apes[i]->offset_ = offset;
363
364       std::vector<Skyline_entry> new_left_skyline = apes[i]->left_skyline_;
365       heighten_skyline (&new_left_skyline, apes[i]->offset_);
366       merge_skyline (&new_left_skyline, left_skyline, LEFT);
367       left_skyline = new_left_skyline;
368     }
369
370   for (vsize i = apes.size (); i--;)
371     {
372       Accidental_placement_entry *ape = apes[i];
373       for (vsize j = ape->grobs_.size (); j--;)
374         ape->grobs_[j]->translate_axis (ape->offset_, X_AXIS);
375     }
376
377   Interval left_extent, right_extent;
378   Accidental_placement_entry *ape = apes[0];
379
380   for (vsize i = ape->extents_.size (); i--;)
381     left_extent.unite (ape->offset_ + ape->extents_[i][X_AXIS]);
382
383   ape = apes.back ();
384   for (vsize i = ape->extents_.size (); i--;)
385     right_extent.unite (ape->offset_ + ape->extents_[i][X_AXIS]);
386
387   left_extent[LEFT] -= robust_scm2double (me->get_property ("left-padding"), 0);
388   Interval width (left_extent[LEFT], right_extent[RIGHT]);
389
390   SCM scm_width = ly_interval2scm (width);
391   me->flush_extent_cache (X_AXIS);
392   me->set_property ("X-extent", scm_width);
393
394   for (vsize i = apes.size (); i--;)
395     delete apes[i];
396
397   return SCM_BOOL_T;
398 }
399
400 ADD_INTERFACE (Accidental_placement,
401                "accidental-placement-interface",
402                "Resolve accidental collisions.",
403
404                /* properties */
405                "accidental-grobs "
406                "left-padding "
407                "padding "
408                "positioning-done "
409                "right-padding ")