2 tuplet-bracket.cc -- implement Tuplet_bracket
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2005 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 TODO: quantise, we don't want to collide with staff lines.
29 (or should we be above staff?)
31 todo: handle breaking elegantly.
36 #include "tuplet-bracket.hh"
37 #include "line-interface.hh"
40 #include "font-interface.hh"
41 #include "output-def.hh"
42 #include "text-item.hh"
44 #include "note-column.hh"
45 #include "group-interface.hh"
46 #include "directional-element-interface.hh"
48 #include "staff-symbol-referencer.hh"
52 get_x_bound_grob (Grob *g, Direction my_dir)
54 if (Note_column::get_stem (g)
55 && Note_column::dir (g) == my_dir)
57 g = Note_column::get_stem (g);
65 Tuplet_bracket::parallel_beam (Grob *me, Link_array<Grob> const &cols, bool *equally_long)
70 Grob *s1 = Note_column::get_stem (cols[0]);
71 Grob *s2 = Note_column::get_stem (cols.top ());
73 Grob*b1 = s1 ? Stem::get_beam (s1) : 0;
74 Grob*b2 = s2 ? Stem::get_beam (s2) : 0;
76 Spanner*sp = dynamic_cast<Spanner*> (me);
78 *equally_long = false;
79 if (! (b1 && (b1 == b2) && !sp->is_broken ()))
82 Link_array<Grob> beam_stems = Pointer_group_interface__extract_grobs
83 (b1, (Grob*)0, "stems");
85 if (beam_stems.size () == 0)
87 programming_error ("Beam under tuplet bracket has no stems!");
92 *equally_long = (beam_stems[0] == s1 && beam_stems.top () == s2);
100 in the case that there is no bracket, but there is a (single) beam,
101 follow beam precisely for determining tuplet number location.
104 MAKE_SCHEME_CALLBACK (Tuplet_bracket, print, 1);
106 Tuplet_bracket::print (SCM smob)
108 Grob *me = unsmob_grob (smob);
110 Link_array<Grob> columns =
111 Pointer_group_interface__extract_grobs (me, (Grob*)0, "note-columns");
113 if (!columns.size ())
114 return mol.smobbed_copy ();
119 SCM lp = me->get_property ("left-position");
120 SCM rp = me->get_property ("right-position");
122 if (!scm_is_number (rp) || !scm_is_number (lp))
123 after_line_breaking (smob);
126 Real ly = robust_scm2double (me->get_property ("left-position"), 0);
127 Real ry = robust_scm2double (me->get_property ("right-position"), 0);
129 bool equally_long = false;
130 Grob * par_beam = parallel_beam (me, columns, &equally_long);
132 Spanner*sp = dynamic_cast<Spanner*> (me);
134 bool bracket_visibility = !(par_beam && equally_long);
135 bool number_visibility = true;
138 Fixme: the type of this prop is sucky.
140 SCM bracket = me->get_property ("bracket-visibility");
141 if (scm_is_bool (bracket))
143 bracket_visibility = ly_scm2bool (bracket);
145 else if (bracket == ly_symbol2scm ("if-no-beam"))
146 bracket_visibility = !par_beam;
148 SCM numb = me->get_property ("number-visibility");
149 if (scm_is_bool (numb))
151 number_visibility = ly_scm2bool (numb);
153 else if (numb == ly_symbol2scm ("if-no-beam"))
154 number_visibility = !par_beam;
156 Grob * commonx = columns[0]->common_refpoint (columns.top (), X_AXIS);
159 Tuplet brackets are normally not broken, but we shouldn't crash if
162 commonx = commonx->common_refpoint (sp->get_bound (LEFT), X_AXIS);
163 commonx = commonx->common_refpoint (sp->get_bound (RIGHT), X_AXIS);
165 Direction dir = get_grob_direction (me);
167 Grob * lgr = get_x_bound_grob (columns[0], dir);
168 Grob * rgr = get_x_bound_grob (columns.top (), dir);
170 Real x0 = robust_relative_extent (lgr, commonx, X_AXIS)[LEFT];
171 Real x1 = robust_relative_extent (rgr, commonx, X_AXIS)[RIGHT];
174 SCM number = me->get_property ("text");
176 Output_def *pap = me->get_layout ();
178 if (scm_is_string (number) && number_visibility)
180 SCM properties = Font_interface::text_font_alist_chain (me);
181 SCM snum = Text_interface::interpret_markup (pap->self_scm (), properties, number);
182 num = *unsmob_stencil (snum);
183 num.align_to (X_AXIS, CENTER);
184 num.translate_axis (w/2, X_AXIS);
185 num.align_to (Y_AXIS, CENTER);
187 num.translate_axis ((ry-ly)/2, Y_AXIS);
189 mol.add_stencil (num);
194 No bracket when it would be smaller than the number.
196 TODO: should use GAP in calculation too.
198 if (bracket_visibility && number_visibility
199 && mol.extent (X_AXIS).length () > w)
201 bracket_visibility = false;
204 if (bracket_visibility)
206 Real ss = Staff_symbol_referencer::staff_space (me);
209 if (!num.extent (X_AXIS).is_empty ())
210 gap = num.extent (X_AXIS).length () + 1.0;
212 SCM fl = me->get_property ("bracket-flare");
213 SCM eh = me->get_property ("edge-height");
214 SCM sp = me->get_property ("shorten-pair");
217 Drul_array<Real> height, flare, shorten;
219 flare[d] = height[d] = shorten[d] = 0.0;
220 if (is_number_pair (fl))
221 flare[d] += ss * scm_to_double (index_get_cell (fl, d));
222 if (is_number_pair (eh))
223 height[d] += - dir * ss *scm_to_double (index_get_cell (eh, d));
224 if (is_number_pair (sp))
225 shorten[d] += ss *scm_to_double (index_get_cell (sp, d));
227 while (flip (&d) != LEFT);
229 Stencil brack = make_bracket (me, Y_AXIS,
233 0.1 = more space at right due to italics
234 TODO: use italic correction of font.
236 Interval (-0.5, 0.5) * gap + 0.1,
238 mol.add_stencil (brack);
241 mol.translate_axis (ly, Y_AXIS);
242 mol.translate_axis (x0 - sp->get_bound (LEFT)->relative_coordinate (commonx, X_AXIS), X_AXIS);
243 return mol.smobbed_copy ();
247 should move to lookup?
249 TODO: this will fail for very short (shorter than the flare)
253 Tuplet_bracket::make_bracket (Grob *me, // for line properties.
256 Drul_array<Real> height,
258 Drul_array<Real> flare,
259 Drul_array<Real> shorten)
261 Drul_array<Offset> corners (Offset (0, 0), dz);
263 Real length = dz.length ();
264 Drul_array<Offset> gap_corners;
267 Axis bracket_axis = other_axis (protusion_axis);
269 Drul_array<Offset> straight_corners = corners;
273 straight_corners[d] += - d * shorten[d] /length * dz;
274 } while (flip (&d) != LEFT);
278 gap = Interval (0, 0);
280 gap_corners[d] = (dz * 0.5) + gap[d] / length * dz;
281 } while (flip (&d) != LEFT);
283 Drul_array<Offset> flare_corners = straight_corners;
285 flare_corners[d][bracket_axis] = straight_corners[d][bracket_axis];
286 flare_corners[d][protusion_axis] += height[d];
287 straight_corners[d][bracket_axis] += - d * flare[d];
288 } while (flip (&d) != LEFT);
292 m.add_stencil (Line_interface::line (me, straight_corners[d],
295 m.add_stencil (Line_interface::line (me, straight_corners[d],
297 } while (flip (&d) != LEFT);
304 use first -> last note for slope, and then correct for disturbing
307 Tuplet_bracket::calc_position_and_height (Grob*me, Real *offset, Real * dy)
309 Link_array<Grob> columns =
310 Pointer_group_interface__extract_grobs (me, (Grob*)0, "note-columns");
312 SCM cols = me->get_property ("note-columns");
313 Grob * commony = common_refpoint_of_list (cols, me, Y_AXIS);
314 Grob * commonx = common_refpoint_of_list (cols, me, X_AXIS);
317 if (Grob * st = Staff_symbol_referencer::get_staff_symbol (me))
318 staff = st->extent (commony, Y_AXIS);
320 Direction dir = get_grob_direction (me);
323 Use outer non-rest columns to determine slope
326 while (l <columns.size () && Note_column::has_rests (columns[l]))
329 int r = columns.size ()- 1;
330 while (r >= l && Note_column::has_rests (columns[r]))
335 Interval rv = columns[r]->extent (commony, Y_AXIS);
336 Interval lv = columns[l]->extent (commony, Y_AXIS);
339 Real graphical_dy = rv[dir] - lv[dir];
341 Slice ls = Note_column::head_positions_interval (columns[l]);
342 Slice rs = Note_column::head_positions_interval (columns[r]);
345 musical_dy[UP] = rs[UP] - ls[UP];
346 musical_dy[DOWN] = rs[DOWN] - ls[DOWN];
347 if (sign (musical_dy[UP]) != sign (musical_dy[DOWN]))
349 else if (sign (graphical_dy) != sign (musical_dy[DOWN]))
358 *offset = - dir * infinity_f;
360 if (!columns.size ())
365 Grob * lgr = get_x_bound_grob (columns[0], dir);
366 Grob * rgr = get_x_bound_grob (columns.top (), dir);
367 Real x0 = robust_relative_extent (lgr, commonx, X_AXIS)[LEFT];
368 Real x1 = robust_relative_extent (rgr, commonx, X_AXIS)[RIGHT];
373 Real factor = columns.size () > 1 ? 1/ (x1 - x0) : 1.0;
375 for (int i = 0; i < columns.size (); i++)
377 Interval note_ext = columns[i]->extent (commony, Y_AXIS);
378 note_ext.unite (staff);
379 Real notey = note_ext[dir] - me->relative_coordinate (commony, Y_AXIS);
381 Real x = columns[i]->relative_coordinate (commonx, X_AXIS) - x0;
382 Real tuplety = *dy * x * factor;
384 if (notey * dir > (*offset + tuplety) * dir)
385 *offset = notey - tuplety;
389 *offset += scm_to_double (me->get_property ("padding")) *dir;
393 horizontal brackets should not collide with staff lines.
396 Real ss = Staff_symbol_referencer::staff_space (me);
397 if (*dy == 0 && fabs (*offset) < ss * Staff_symbol_referencer::staff_radius (me))
399 // quantize, then do collision check.
402 *offset = rint (*offset);
403 if (Staff_symbol_referencer::on_staffline (me, (int) rint (*offset)))
414 We depend on the beams if there are any.
416 MAKE_SCHEME_CALLBACK (Tuplet_bracket, before_line_breaking, 1);
418 Tuplet_bracket::before_line_breaking (SCM smob)
420 Grob *me = unsmob_grob (smob);
421 Link_array<Grob> columns =
422 Pointer_group_interface__extract_grobs (me, (Grob*)0, "note-columns");
425 for (int i = columns.size (); i--;)
427 Grob * s = Note_column::get_stem (columns[i]);
428 Grob * b = s ? Stem::get_beam (s): 0;
430 me->add_dependency (b);
432 return SCM_UNSPECIFIED;
435 MAKE_SCHEME_CALLBACK (Tuplet_bracket, after_line_breaking, 1);
438 Tuplet_bracket::after_line_breaking (SCM smob)
440 Grob * me = unsmob_grob (smob);
441 Link_array<Grob> columns =
442 Pointer_group_interface__extract_grobs (me, (Grob*)0, "note-columns");
444 if (!columns.size ())
447 return SCM_UNSPECIFIED;
449 if (dynamic_cast<Spanner*> (me)->is_broken ())
451 me->warning (_("Killing tuplet bracket across linebreak."));
453 return SCM_UNSPECIFIED;
456 Direction dir = get_grob_direction (me);
459 dir = Tuplet_bracket::get_default_dir (me);
460 set_grob_direction (me, dir);
463 bool equally_long = false;
464 Grob * par_beam = parallel_beam (me, columns, &equally_long);
467 We follow the beam only if there is one, and we are next to it.
471 || get_grob_direction (par_beam) != dir)
473 calc_position_and_height (me, &offset, &dy);
477 SCM ps = par_beam->get_property ("positions");
479 Real lp = scm_to_double (scm_car (ps));
480 Real rp = scm_to_double (scm_cdr (ps));
485 offset = lp + dir * (0.5 + scm_to_double (me->get_property ("padding")));
490 SCM lp = me->get_property ("left-position");
491 SCM rp = me->get_property ("right-position");
493 if (scm_is_number (lp) && !scm_is_number (rp))
495 rp = scm_make_real (scm_to_double (lp) + dy);
497 else if (scm_is_number (rp) && !scm_is_number (lp))
499 lp = scm_make_real (scm_to_double (rp) - dy);
501 else if (!scm_is_number (rp) && !scm_is_number (lp))
503 lp = scm_make_real (offset);
504 rp = scm_make_real (offset + dy);
507 me->set_property ("left-position", lp);
508 me->set_property ("right-position", rp);
510 return SCM_UNSPECIFIED;
518 Tuplet_bracket::get_default_dir (Grob*me)
520 Drul_array<int> dirs (0, 0);
521 for (SCM s = me->get_property ("note-columns"); scm_is_pair (s); s = scm_cdr (s))
523 Grob * nc = unsmob_grob (scm_car (s));
524 Direction d = Note_column::dir (nc);
529 return dirs[UP] >= dirs[DOWN] ? UP : DOWN;
533 Tuplet_bracket::add_column (Grob*me, Item*n)
535 Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-columns"), n);
536 me->add_dependency (n);
538 add_bound_item (dynamic_cast<Spanner*> (me), n);
546 ADD_INTERFACE (Tuplet_bracket,
547 "tuplet-bracket-interface",
548 "A bracket with a number in the middle, used for tuplets.",
550 "note-columns bracket-flare edge-height shorten-pair "
551 "padding left-position right-position bracket-visibility "
552 "number-visibility thickness direction");