2 tuplet-bracket.cc -- implement Tuplet_bracket
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2003 Jan Nieuwenhuizen <janneke@gnu.org>
7 Han-Wen Nienhuys <hanwen@xs4all.nl>
13 - tuplet bracket should probably be subject to the same rules as
14 beam sloping/quanting.
16 - There is no support for kneed brackets, or nested brackets.
18 - number placement for parallel beams should be much more advanced:
19 for sloped beams some extra horizontal offset must be introduced.
21 - number placement is usually done over the center note, not the
28 #include "line-interface.hh"
32 #include "font-interface.hh"
33 #include "molecule.hh"
34 #include "paper-def.hh"
35 #include "text-item.hh"
36 #include "tuplet-bracket.hh"
38 #include "note-column.hh"
39 #include "group-interface.hh"
40 #include "directional-element-interface.hh"
42 #include "staff-symbol-referencer.hh"
47 get_x_bound_grob (Grob *g, Direction my_dir)
49 if (Note_column::get_stem (g)
50 && Note_column::dir (g) == my_dir)
52 g = Note_column::get_stem (g);
60 Tuplet_bracket::parallel_beam (Grob *me, Link_array<Grob> const &cols, bool *equally_long)
65 Grob *s1 = Note_column::get_stem (cols[0]);
66 Grob *s2 = Note_column::get_stem (cols.top());
68 Grob*b1 = s1 ? Stem::get_beam (s1) : 0;
69 Grob*b2 = s2 ? Stem::get_beam (s2) : 0;
71 Spanner*sp = dynamic_cast<Spanner*> (me);
74 if (! (b1 && (b1 == b2) && !sp->broken_b()))
77 Link_array<Grob> beam_stems = Pointer_group_interface__extract_grobs
78 (b1, (Grob*)0, "stems");
80 if (beam_stems.size() == 0)
82 programming_error ("Beam under tuplet bracket has no stems!");
87 *equally_long = (beam_stems[0] == s1 && beam_stems.top() == s2);
95 in the case that there is no bracket, but there is a (single) beam,
96 follow beam precisely for determining tuplet number location.
99 MAKE_SCHEME_CALLBACK (Tuplet_bracket,brew_molecule,1);
101 Tuplet_bracket::brew_molecule (SCM smob)
103 Grob *me= unsmob_grob (smob);
105 Link_array<Grob> columns=
106 Pointer_group_interface__extract_grobs (me, (Grob*)0, "note-columns");
108 if (!columns.size ())
109 return mol.smobbed_copy ();
114 SCM lp = me->get_grob_property ("left-position");
115 SCM rp = me->get_grob_property ("right-position");
117 if (!gh_number_p (rp) || !gh_number_p (lp))
118 after_line_breaking (smob);
121 Real ly = robust_scm2double (me->get_grob_property ("left-position"), 0);
122 Real ry = robust_scm2double (me->get_grob_property ("right-position"), 0);
124 bool equally_long = false;
125 Grob * par_beam = parallel_beam (me, columns, &equally_long);
127 Spanner*sp = dynamic_cast<Spanner*> (me);
129 bool bracket_visibility = !(par_beam && equally_long);
130 bool number_visibility = true;
133 Fixme: the type of this prop is sucky.
135 SCM bracket = me->get_grob_property ("bracket-visibility");
136 if (gh_boolean_p (bracket))
138 bracket_visibility = gh_scm2bool (bracket);
140 else if (bracket == ly_symbol2scm ("if-no-beam"))
141 bracket_visibility = !par_beam;
143 SCM numb = me->get_grob_property ("number-visibility");
144 if (gh_boolean_p (numb))
146 number_visibility = gh_scm2bool (numb);
148 else if (numb == ly_symbol2scm ("if-no-beam"))
149 number_visibility = !par_beam;
151 Grob * commonx = columns[0]->common_refpoint (columns.top (),X_AXIS);
154 Tuplet brackets are normally not broken, but we shouldn't crash if
157 commonx = commonx->common_refpoint (sp->get_bound(LEFT), X_AXIS);
158 commonx = commonx->common_refpoint (sp->get_bound(RIGHT), X_AXIS);
160 Direction dir = get_grob_direction (me);
162 Grob * lgr = get_x_bound_grob (columns[0], dir);
163 Grob * rgr = get_x_bound_grob (columns.top(), dir);
164 Real x0 = lgr->extent (commonx,X_AXIS)[LEFT];
165 Real x1 = rgr->extent (commonx,X_AXIS)[RIGHT];
169 SCM number = me->get_grob_property ("text");
171 Paper_def *pap = me->get_paper ();
172 if (gh_string_p (number) && number_visibility)
174 SCM properties = Font_interface::font_alist_chain (me);
175 SCM snum = Text_item::interpret_markup (pap->self_scm (), properties, number);
176 Molecule num = *unsmob_molecule (snum);
177 num.align_to (X_AXIS, CENTER);
178 num.translate_axis (w/2, X_AXIS);
179 num.align_to (Y_AXIS, CENTER);
181 num.translate_axis ((ry-ly)/2, Y_AXIS);
183 mol.add_molecule (num);
188 No bracket when it would be smaller than the number.
190 TODO: should use GAP in calculation too.
192 if (bracket_visibility && number_visibility
193 && mol.extent (X_AXIS).length () > w)
195 bracket_visibility = false;
198 if (bracket_visibility)
200 Real ss = Staff_symbol_referencer::staff_space (me);
201 Real gap = robust_scm2double (me->get_grob_property ("gap"), 1.0)
204 SCM fl = me->get_grob_property ("bracket-flare");
205 SCM eh = me->get_grob_property ("edge-height");
206 SCM sp = me->get_grob_property ("shorten-pair");
209 Drul_array<Real> height, flare, shorten;
211 flare[d] = height[d] = shorten[d] = 0.0;
212 if (is_number_pair (fl))
213 flare[d] += ss * gh_scm2double (index_get_cell (fl, d));
214 if (is_number_pair (eh))
215 height[d] += - dir * ss *gh_scm2double (index_get_cell (eh, d));
216 if (is_number_pair (sp))
217 shorten[d] += ss *gh_scm2double (index_get_cell (sp, d));
219 while (flip (&d) != LEFT);
221 Molecule brack = make_bracket (me, Y_AXIS,
225 mol.add_molecule (brack);
228 mol.translate_axis (ly, Y_AXIS);
229 mol.translate_axis (x0 - sp->get_bound (LEFT)->relative_coordinate (commonx,X_AXIS),X_AXIS);
230 return mol.smobbed_copy ();
234 should move to lookup?
236 TODO: this will fail for very short (shorter than the flare)
240 Tuplet_bracket::make_bracket (Grob *me, // for line properties.
243 Drul_array<Real> height,
245 Drul_array<Real> flare,
246 Drul_array<Real> shorten)
248 Drul_array<Offset> corners (Offset(0,0), dz);
250 Real length = dz.length ();
251 Drul_array<Offset> gap_corners;
254 Axis bracket_axis = other_axis (protusion_axis);
256 Drul_array<Offset> straight_corners = corners;
260 straight_corners[d] += - d * shorten[d] /length * dz;
261 } while (flip (&d) != LEFT);
264 UGH: the shortening factor is magic.
267 (0.66 * (straight_corners[RIGHT] - straight_corners[LEFT]).length ());
270 gap_corners[d] = (dz * 0.5) + d * 0.5 * gap / length * dz;
271 } while (flip (&d) != LEFT);
273 Drul_array<Offset> flare_corners = straight_corners;
275 flare_corners[d][bracket_axis] = straight_corners[d][bracket_axis];
276 flare_corners[d][protusion_axis] += height[d];
277 straight_corners[d][bracket_axis] += - d * flare[d];
278 } while (flip (&d) != LEFT);
282 m.add_molecule (Line_interface::line (me, straight_corners[d],
285 m.add_molecule (Line_interface::line (me, straight_corners[d],
287 } while (flip (&d) != LEFT);
294 use first -> last note for slope, and then correct for disturbing
297 Tuplet_bracket::calc_position_and_height (Grob*me,Real *offset, Real * dy)
299 Link_array<Grob> columns=
300 Pointer_group_interface__extract_grobs (me, (Grob*)0, "note-columns");
303 SCM cols = me->get_grob_property ("note-columns");
304 Grob * commony = common_refpoint_of_list (cols, me, Y_AXIS);
305 Grob * commonx = common_refpoint_of_list (cols, me, X_AXIS);
308 if (Grob * st = Staff_symbol_referencer::get_staff_symbol (me))
309 staff = st->extent (commony, Y_AXIS);
311 Direction dir = get_grob_direction (me);
314 Use outer non-rest columns to determine slope
317 while (l <columns.size () && Note_column::rest_b (columns[l]))
320 int r = columns.size ()- 1;
321 while (r >= l && Note_column::rest_b (columns[r]))
326 Interval rv =columns[r]->extent (commony, Y_AXIS);
327 Interval lv =columns[l]->extent (commony, Y_AXIS);
330 Real graphical_dy = rv[dir] - lv[dir];
332 Slice ls = Note_column::head_positions_interval (columns[l]);
333 Slice rs = Note_column::head_positions_interval (columns[r]);
336 musical_dy[UP] = rs[UP] - ls[UP];
337 musical_dy[DOWN] = rs[DOWN] - ls[DOWN];
338 if (sign (musical_dy[UP]) != sign (musical_dy[DOWN]))
340 else if (sign (graphical_dy) != sign (musical_dy[DOWN]))
349 *offset = - dir * infinity_f;
351 if (!columns.size ())
356 Grob * lgr = get_x_bound_grob (columns[0], dir);
357 Grob * rgr = get_x_bound_grob (columns.top(), dir);
358 Real x0 = lgr->extent (commonx,X_AXIS)[LEFT];
359 Real x1 = rgr->extent (commonx,X_AXIS)[RIGHT];
365 Real factor = columns.size () > 1 ? 1/ (x1 - x0) : 1.0;
367 for (int i = 0; i < columns.size (); i++)
369 Interval note_ext =columns[i]->extent (commony, Y_AXIS);
370 note_ext.unite (staff);
371 Real notey = note_ext[dir] - me->relative_coordinate (commony, Y_AXIS);
373 Real x = columns[i]->relative_coordinate (commonx, X_AXIS) - x0;
374 Real tuplety = *dy * x * factor;
376 if (notey * dir > (*offset + tuplety) * dir)
377 *offset = notey - tuplety;
381 *offset += gh_scm2double (me->get_grob_property ("padding")) *dir;
385 horizontal brackets should not collide with staff lines.
388 Real ss= Staff_symbol_referencer::staff_space (me);
389 if (*dy == 0 && fabs (*offset) < ss * Staff_symbol_referencer::staff_radius (me))
391 // quantize, then do collision check.
394 *offset = rint (*offset);
395 if (Staff_symbol_referencer::on_staffline (me, (int) rint (*offset)))
406 We depend on the beams if there are any.
408 MAKE_SCHEME_CALLBACK (Tuplet_bracket,before_line_breaking,1);
410 Tuplet_bracket::before_line_breaking (SCM smob)
412 Grob *me = unsmob_grob (smob);
413 Link_array<Grob> columns=
414 Pointer_group_interface__extract_grobs (me, (Grob*)0, "note-columns");
417 for (int i = columns.size(); i--;)
419 Grob * s =Note_column::get_stem (columns[i]);
420 Grob * b = s ? Stem::get_beam (s): 0;
422 me->add_dependency (b);
424 return SCM_UNDEFINED;
427 MAKE_SCHEME_CALLBACK (Tuplet_bracket,after_line_breaking,1);
430 Tuplet_bracket::after_line_breaking (SCM smob)
432 Grob * me = unsmob_grob (smob);
433 Link_array<Grob> columns=
434 Pointer_group_interface__extract_grobs (me, (Grob*)0, "note-columns");
436 if (!columns.size ())
439 return SCM_UNSPECIFIED;
441 if (dynamic_cast<Spanner*> (me)->broken_b ())
443 me->warning (_("Killing tuplet bracket across linebreak."));
445 return SCM_UNSPECIFIED;
448 Direction dir = get_grob_direction (me);
451 dir = Tuplet_bracket::get_default_dir (me);
452 set_grob_direction (me, dir);
455 bool equally_long = false;
456 Grob * par_beam = parallel_beam (me, columns, &equally_long);
459 We follow the beam only if there is one, and we are next to it.
463 || get_grob_direction (par_beam) != dir)
465 calc_position_and_height (me,&offset,&dy);
469 SCM ps = par_beam->get_grob_property ("positions");
471 Real lp = gh_scm2double (gh_car (ps));
472 Real rp = gh_scm2double (gh_cdr (ps));
477 offset = lp + dir * (0.5 + gh_scm2double (me->get_grob_property ("padding")));
482 SCM lp = me->get_grob_property ("left-position");
483 SCM rp = me->get_grob_property ("right-position");
485 if (gh_number_p (lp) && !gh_number_p (rp))
487 rp = gh_double2scm (gh_scm2double (lp) + dy);
489 else if (gh_number_p (rp) && !gh_number_p (lp))
491 lp = gh_double2scm (gh_scm2double (rp) - dy);
493 else if (!gh_number_p (rp) && !gh_number_p (lp))
495 lp = gh_double2scm (offset);
496 rp = gh_double2scm (offset +dy);
499 me->set_grob_property ("left-position", lp);
500 me->set_grob_property ("right-position", rp);
502 return SCM_UNSPECIFIED;
510 Tuplet_bracket::get_default_dir (Grob*me)
512 Drul_array<int> dirs(0,0);
513 for (SCM s = me->get_grob_property ("note-columns"); gh_pair_p (s); s = ly_cdr (s))
515 Grob * nc = unsmob_grob (ly_car (s));
516 Direction d = Note_column::dir (nc);
521 return dirs[UP] >= dirs[DOWN] ? UP : DOWN;
525 Tuplet_bracket::add_column (Grob*me, Item*n)
527 Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-columns"), n);
528 me->add_dependency (n);
530 add_bound_item (dynamic_cast<Spanner*> (me), n);
538 ADD_INTERFACE (Tuplet_bracket,"tuplet-bracket-interface",
539 "A bracket with a number in the middle, used for tuplets.",
540 "note-columns bracket-flare edge-height shorten-pair padding gap left-position right-position bracket-visibility number-visibility thickness direction");