2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2015 Jan Nieuwenhuizen <janneke@gnu.org>
5 Han-Wen Nienhuys <hanwen@xs4all.nl>
7 LilyPond is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 LilyPond is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
24 - tuplet bracket should probably be subject to the same rules as
25 beam sloping/quanting.
27 - There is no support for kneed brackets, or nested brackets.
29 - number placement for parallel beams should be much more advanced:
30 for sloped beams some extra horizontal offset must be introduced.
32 - number placement is usually done over the center note, not the
37 TODO: quantise, we don't want to collide with staff lines.
38 (or should we be above staff?)
40 todo: handle breaking elegantly.
43 #include "tuplet-bracket.hh"
46 #include "axis-group-interface.hh"
47 #include "line-interface.hh"
50 #include "output-def.hh"
51 #include "font-interface.hh"
52 #include "text-interface.hh"
54 #include "note-column.hh"
55 #include "pointer-group-interface.hh"
56 #include "directional-element-interface.hh"
59 #include "staff-symbol-referencer.hh"
61 #include "paper-column.hh"
65 get_x_bound_item (Grob *me_grob, Direction hdir, Direction my_dir)
67 Spanner *me = dynamic_cast<Spanner *> (me_grob);
68 Item *g = me->get_bound (hdir);
69 if (has_interface<Note_column> (g)
70 && Note_column::get_stem (g)
71 && Note_column::dir (g) == my_dir)
72 g = Note_column::get_stem (g);
78 flatten_number_pair_property (Grob *me, Direction xdir, SCM sym)
80 Drul_array<Real> zero (0, 0);
82 = robust_scm2drul (me->get_property (sym), zero);
85 me->set_property (sym, ly_interval2scm (pair));
89 Return beam that encompasses the span of the tuplet bracket.
92 Tuplet_bracket::parallel_beam (Grob *me_grob, vector<Grob *> const &cols,
95 Spanner *me = dynamic_cast<Spanner *> (me_grob);
97 Item *left = me->get_bound (LEFT);
98 Item *right = me->get_bound (RIGHT);
99 if (!left || left->break_status_dir ()
100 || !right || right->break_status_dir ())
103 Drul_array<Grob *> stems (Note_column::get_stem (cols[0]),
104 Note_column::get_stem (cols.back ()));
108 || (dynamic_cast<Item *> (stems[RIGHT])->get_column ()
109 != me->get_bound (RIGHT)->get_column ()))
112 Drul_array<Grob *> beams;
113 for (LEFT_and_RIGHT (d))
114 beams[d] = stems[d] ? Stem::get_beam (stems[d]) : 0;
116 *equally_long = false;
117 if (! (beams[LEFT] && (beams[LEFT] == beams[RIGHT]) && !me->is_broken ()))
120 extract_grob_set (beams[LEFT], "stems", beam_stems);
121 if (beam_stems.size () == 0)
123 programming_error ("beam under tuplet bracket has no stems");
129 = (beam_stems[0] == stems[LEFT]
130 && beam_stems.back () == stems[RIGHT]);
134 MAKE_SCHEME_CALLBACK (Tuplet_bracket, calc_connect_to_neighbors, 1);
136 Tuplet_bracket::calc_connect_to_neighbors (SCM smob)
138 Spanner *me = unsmob<Spanner> (smob);
140 Direction dir = get_grob_direction (me);
141 Drul_array<Item *> bounds (get_x_bound_item (me, LEFT, dir),
142 get_x_bound_item (me, RIGHT, dir));
144 Drul_array<bool> connect_to_other (false, false);
145 for (LEFT_and_RIGHT (d))
147 Direction break_dir = bounds[d]->break_status_dir ();
148 Spanner *orig_spanner = dynamic_cast<Spanner *> (me->original ());
149 vsize neighbor_idx = me->get_break_index () - break_dir;
152 && neighbor_idx < orig_spanner->broken_intos_.size ())
154 Grob *neighbor = orig_spanner->broken_intos_[neighbor_idx];
156 /* trigger possible suicide*/
157 (void) neighbor->get_property ("positions");
162 && neighbor_idx < orig_spanner->broken_intos_.size ()
163 && orig_spanner->broken_intos_[neighbor_idx]->is_live ());
166 if (connect_to_other[LEFT] || connect_to_other[RIGHT])
167 return scm_cons (scm_from_bool (connect_to_other[LEFT]),
168 scm_from_bool (connect_to_other[RIGHT]));
174 Tuplet_bracket::get_common_x (Spanner *me)
176 extract_grob_set (me, "note-columns", columns);
178 Grob *commonx = common_refpoint_of_array (columns, me, X_AXIS);
179 commonx = commonx->common_refpoint (me->get_bound (LEFT), X_AXIS);
180 commonx = commonx->common_refpoint (me->get_bound (RIGHT), X_AXIS);
185 MAKE_SCHEME_CALLBACK (Tuplet_bracket, calc_x_positions, 1)
187 Tuplet_bracket::calc_x_positions (SCM smob)
189 Spanner *me = unsmob<Spanner> (smob);
190 extract_grob_set (me, "note-columns", columns);
192 Grob *commonx = get_common_x (me);
193 Direction dir = get_grob_direction (me);
195 Drul_array<Item *> bounds;
196 bounds[LEFT] = get_x_bound_item (me, LEFT, dir);
197 bounds[RIGHT] = get_x_bound_item (me, RIGHT, dir);
199 Drul_array<bool> connect_to_other
200 = robust_scm2booldrul (me->get_property ("connect-to-neighbor"),
201 Drul_array<bool> (false, false));
204 for (LEFT_and_RIGHT (d))
206 x_span[d] = Axis_group_interface::generic_bound_extent (bounds[d], commonx, X_AXIS)[d];
208 if (connect_to_other[d])
210 Interval overshoot (robust_scm2drul (me->get_property ("break-overshoot"),
211 Interval (-0.5, 0.0)));
214 x_span[d] += d * overshoot[d];
216 x_span[d] = (bounds[d]->break_status_dir ()
217 ? Axis_group_interface::generic_bound_extent (bounds[d], commonx, X_AXIS)[-d]
218 : robust_relative_extent (bounds[d], commonx, X_AXIS)[-d])
224 || (bounds[d]->get_column ()
225 != dynamic_cast<Item *> (columns.back ())->get_column ())))
228 We're connecting to a column, for the last bit of a broken
232 = robust_scm2double (me->get_property ("full-length-padding"), 1.0);
234 if (bounds[d]->break_status_dir ())
237 Real coord = bounds[d]->relative_coordinate (commonx, X_AXIS);
238 if (to_boolean (me->get_property ("full-length-to-extent")))
239 coord = robust_relative_extent (bounds[d], commonx, X_AXIS)[LEFT];
241 coord = max (coord, x_span[LEFT]);
243 x_span[d] = coord - padding;
247 return ly_interval2scm (x_span - me->get_bound (LEFT)->relative_coordinate (commonx, X_AXIS));
253 in the case that there is no bracket, but there is a (single) beam,
254 follow beam precisely for determining tuplet number location.
256 MAKE_SCHEME_CALLBACK (Tuplet_bracket, print, 1);
258 Tuplet_bracket::print (SCM smob)
260 Spanner *me = unsmob<Spanner> (smob);
263 extract_grob_set (me, "note-columns", columns);
264 bool equally_long = false;
265 Grob *par_beam = parallel_beam (me, columns, &equally_long);
267 bool bracket_visibility = !(par_beam && equally_long); // Flag, print/don't print tuplet bracket.
269 FIXME: The type of this prop is sucky.
271 SCM bracket_vis_prop = me->get_property ("bracket-visibility");
272 bool bracket_prop = ly_scm2bool (bracket_vis_prop); // Flag, user has set bracket-visibility prop.
273 bool bracket = scm_is_eq (bracket_vis_prop, ly_symbol2scm ("if-no-beam"));
274 if (scm_is_bool (bracket_vis_prop))
275 bracket_visibility = bracket_prop;
277 bracket_visibility = !par_beam;
280 Don't print a tuplet bracket and number if
281 no X or Y positions were calculated.
283 SCM scm_x_span = me->get_property ("X-positions");
284 SCM scm_positions = me->get_property ("positions");
285 if (!scm_is_pair (scm_x_span) || !scm_is_pair (scm_positions))
290 /* if the tuplet does not span any time, i.e. a single-note tuplet, hide
291 the bracket, but still let the number be displayed.
292 Only do this if the user has not explicitly specified bracket-visibility = #t.
294 if (!to_boolean (bracket_vis_prop)
295 && (robust_scm2moment (me->get_bound (LEFT)->get_column ()->get_property ("when"), Moment (0))
296 == robust_scm2moment (me->get_bound (RIGHT)->get_column ()->get_property ("when"), Moment (0))))
297 bracket_visibility = false;
299 Interval x_span = robust_scm2interval (scm_x_span, Interval (0.0, 0.0));
300 Interval positions = robust_scm2interval (scm_positions, Interval (0.0, 0.0));
302 Drul_array<Offset> points;
303 for (LEFT_and_RIGHT (d))
304 points[d] = Offset (x_span[d], positions[d]);
306 Output_def *pap = me->layout ();
308 Grob *number_grob = unsmob<Grob> (me->get_object ("tuplet-number"));
311 Don't print the bracket when it would be smaller than the number.
312 ...Unless the user has coded bracket-visibility = #t, that is.
315 if (bracket_visibility && number_grob)
317 Interval ext = number_grob->extent (number_grob, X_AXIS);
318 if (!ext.is_empty ())
320 gap = ext.length () + 1.0;
322 if ((0.75 * x_span.length () < gap) && !bracket_prop)
323 bracket_visibility = false;
327 if (bracket_visibility)
329 Drul_array<Real> zero (0, 0);
330 Real ss = Staff_symbol_referencer::staff_space (me);
331 Drul_array<Real> height
332 = robust_scm2drul (me->get_property ("edge-height"), zero);
333 Drul_array<Real> flare
334 = robust_scm2drul (me->get_property ("bracket-flare"), zero);
335 Drul_array<Real> shorten
336 = robust_scm2drul (me->get_property ("shorten-pair"), zero);
337 Drul_array<Stencil> edge_stencils;
339 Direction dir = get_grob_direction (me);
341 scale_drul (&height, -ss * dir);
342 scale_drul (&flare, ss);
343 scale_drul (&shorten, ss);
345 Drul_array<bool> connect_to_other
346 = robust_scm2booldrul (me->get_property ("connect-to-neighbor"),
347 Drul_array<bool> (false, false));
349 for (LEFT_and_RIGHT (d))
351 if (connect_to_other[d])
357 SCM edge_text = me->get_property ("edge-text");
359 if (scm_is_pair (edge_text))
361 SCM properties = Font_interface::text_font_alist_chain (me);
362 SCM text = index_get_cell (edge_text, d);
363 if (Text_interface::is_markup (text))
366 = Text_interface::interpret_markup (pap->self_scm (),
369 Stencil *edge_text = unsmob<Stencil> (t);
370 edge_text->translate_axis (x_span[d] - x_span[LEFT],
372 edge_stencils[d] = *edge_text;
379 Bracket::make_bracket (
380 me, Y_AXIS, points[RIGHT] - points[LEFT], height,
382 0.1 = more space at right due to italics
383 TODO: use italic correction of font.
385 Interval (-0.5, 0.5) * gap + 0.1,
388 for (LEFT_and_RIGHT (d))
390 if (!edge_stencils[d].is_empty ())
391 brack.add_stencil (edge_stencils[d]);
394 mol.add_stencil (brack);
397 mol.translate (points[LEFT]);
398 return mol.smobbed_copy ();
402 Tuplet_bracket::get_bounds (Grob *me, Grob **left, Grob **right)
404 extract_grob_set (me, "note-columns", columns);
406 while (l < columns.size () && Note_column::has_rests (columns[l]))
409 vsize r = columns.size ();
410 while (r > l && Note_column::has_rests (columns[r - 1]))
418 *right = columns[r - 1];
423 use first -> last note for slope, and then correct for disturbing
426 Tuplet_bracket::calc_position_and_height (Grob *me_grob, Real *offset, Real *dy)
428 Spanner *me = dynamic_cast<Spanner *> (me_grob);
430 extract_grob_set (me, "note-columns", columns);
431 extract_grob_set (me, "tuplets", tuplets);
433 Grob *commony = common_refpoint_of_array (columns, me, Y_AXIS);
434 commony = common_refpoint_of_array (tuplets, commony, Y_AXIS);
435 if (Grob *st = Staff_symbol_referencer::get_staff_symbol (me))
436 commony = st->common_refpoint (commony, Y_AXIS);
437 Real my_offset = me->relative_coordinate (commony, Y_AXIS);
439 Grob *commonx = get_common_x (me);
440 commonx = common_refpoint_of_array (tuplets, commonx, Y_AXIS);
443 Grob *st = Staff_symbol_referencer::get_staff_symbol (me);
445 /* staff-padding doesn't work correctly on cross-staff tuplets
446 because it only considers one staff symbol. Until this works,
448 if (st && !to_boolean (me->get_property ("cross-staff")))
450 Real pad = robust_scm2double (me->get_property ("staff-padding"), -1.0);
453 staff = st->extent (commony, Y_AXIS) - my_offset;
458 Direction dir = get_grob_direction (me);
460 bool equally_long = false;
461 Grob *par_beam = parallel_beam (me, columns, &equally_long);
463 Item *lgr = get_x_bound_item (me, LEFT, dir);
464 Item *rgr = get_x_bound_item (me, RIGHT, dir);
465 Real x0 = robust_relative_extent (lgr, commonx, X_AXIS)[LEFT];
466 Real x1 = robust_relative_extent (rgr, commonx, X_AXIS)[RIGHT];
467 bool follow_beam = par_beam
468 && get_grob_direction (par_beam) == dir
469 && !Beam::is_knee (par_beam);
471 vector<Offset> points;
474 && Note_column::get_stem (columns[0])
475 && Note_column::get_stem (columns.back ()))
477 Drul_array<Grob *> stems (Note_column::get_stem (columns[0]),
478 Note_column::get_stem (columns.back ()));
481 for (LEFT_and_RIGHT (side))
483 // Trigger setting of stem lengths if necessary.
484 if (Grob *beam = Stem::get_beam (stems[side]))
485 (void) beam->get_property ("quantized-positions");
486 poss[side] = stems[side]->extent (stems[side], Y_AXIS)[get_grob_direction (stems[side])]
487 + stems[side]->parent_relative (commony, Y_AXIS);
490 *dy = poss[RIGHT] - poss[LEFT];
491 points.push_back (Offset (stems[LEFT]->relative_coordinate (commonx, X_AXIS) - x0, poss[LEFT]));
492 points.push_back (Offset (stems[RIGHT]->relative_coordinate (commonx, X_AXIS) - x0, poss[RIGHT]));
497 Use outer non-rest columns to determine slope
501 get_bounds (me, &left_col, &right_col);
502 if (left_col && right_col)
504 Interval rv = Note_column::cross_staff_extent (right_col, commony);
505 Interval lv = Note_column::cross_staff_extent (left_col, commony);
509 Real graphical_dy = rv[dir] - lv[dir];
511 Slice ls = Note_column::head_positions_interval (left_col);
512 Slice rs = Note_column::head_positions_interval (right_col);
515 musical_dy[UP] = rs[UP] - ls[UP];
516 musical_dy[DOWN] = rs[DOWN] - ls[DOWN];
517 if (sign (musical_dy[UP]) != sign (musical_dy[DOWN]))
519 else if (sign (graphical_dy) != sign (musical_dy[DOWN]))
527 for (vsize i = 0; i < columns.size (); i++)
529 Interval note_ext = Note_column::cross_staff_extent (columns[i],
531 Real x = columns[i]->relative_coordinate (commonx, X_AXIS) - x0;
533 points.push_back (Offset (x, note_ext[dir]));
539 points.push_back (Offset (x0 - x0, staff[dir]));
540 points.push_back (Offset (x1 - x0, staff[dir]));
544 This is a slight hack. We compute two encompass points from the
545 bbox of the smaller tuplets.
547 We assume that the smaller bracket is 1.0 space high.
549 Real ss = Staff_symbol_referencer::staff_space (me);
550 for (vsize i = 0; i < tuplets.size (); i++)
552 Interval tuplet_x (tuplets[i]->extent (commonx, X_AXIS));
553 Interval tuplet_y (tuplets[i]->extent (commony, Y_AXIS));
555 if (!tuplets[i]->is_live ())
558 Drul_array<Real> positions
559 = robust_scm2interval (tuplets[i]->get_property ("positions"),
562 Real other_dy = positions[RIGHT] - positions[LEFT];
564 for (LEFT_and_RIGHT (d))
567 = tuplet_y.linear_combination (d * sign (other_dy));
570 We don't take padding into account for nested tuplets.
571 the edges can come very close to the stems, likewise for
575 points.push_back (Offset (tuplet_x[d] - x0, y));
578 // Check for number-on-bracket collisions
579 Grob *number = unsmob<Grob> (tuplets[i]->get_object ("tuplet-number"));
582 Interval x_ext = robust_relative_extent (number, commonx, X_AXIS);
583 Interval y_ext = robust_relative_extent (number, commony, Y_AXIS);
584 points.push_back (Offset (x_ext.center () - x0, y_ext[dir]));
588 if (to_boolean (me->get_property ("avoid-scripts"))
589 && !scm_is_number (me->get_property ("outside-staff-priority")))
591 extract_grob_set (me, "scripts", scripts);
592 for (vsize i = 0; i < scripts.size (); i++)
594 if (!scripts[i]->is_live ())
596 if (scm_is_number (scripts[i]->get_property ("outside-staff-priority")))
599 // assume that if a script is avoiding slurs, it should not get placed
600 // under a tuplet bracket
601 if (unsmob<Grob> (scripts[i]->get_object ("slur")))
605 = robust_relative_extent (scripts[i], commonx, X_AXIS);
607 = robust_relative_extent (scripts[i], commony, Y_AXIS);
609 points.push_back (Offset (script_x.center () - x0,
614 *offset = -dir * infinity_f;
615 Real factor = (columns.size () > 1) ? 1 / (x1 - x0) : 1.0;
616 for (vsize i = 0; i < points.size (); i++)
618 Real x = points[i][X_AXIS];
619 Real tuplety = (*dy) * x * factor + my_offset;
621 if (points[i][Y_AXIS] * dir > (*offset + tuplety) * dir)
622 *offset = points[i][Y_AXIS] - tuplety;
625 *offset += scm_to_double (me->get_property ("padding")) * dir;
628 horizontal brackets should not collide with staff lines.
630 This doesn't seem to support cross-staff tuplets atm.
634 // quantize, then do collision check.
637 Interval staff_span = Staff_symbol_referencer::staff_span (me);
638 if (staff_span.contains (*offset))
640 *offset = rint (*offset);
641 if (Staff_symbol_referencer::on_line (me, int (*offset)))
649 MAKE_SCHEME_CALLBACK (Tuplet_bracket, calc_direction, 1);
651 Tuplet_bracket::calc_direction (SCM smob)
653 Grob *me = unsmob<Grob> (smob);
654 Direction dir = Tuplet_bracket::get_default_dir (me);
655 return scm_from_int (dir);
658 MAKE_SCHEME_CALLBACK (Tuplet_bracket, calc_positions, 1);
660 Tuplet_bracket::calc_positions (SCM smob)
662 Spanner *me = unsmob<Spanner> (smob);
666 calc_position_and_height (me, &offset, &dy);
668 SCM x = scm_cons (scm_from_double (offset),
669 scm_from_double (offset + dy));
678 Tuplet_bracket::get_default_dir (Grob *me)
680 Drul_array<int> dirs (0, 0);
681 extract_grob_set (me, "note-columns", columns);
682 for (vsize i = 0; i < columns.size (); i++)
684 Grob *nc = columns[i];
685 if (Note_column::has_rests (nc))
687 Direction d = Note_column::dir (nc);
692 if (dirs[UP] == dirs[DOWN])
696 Grob *staff = Staff_symbol_referencer::get_staff_symbol (me);
699 Interval staff_extent = staff->extent (staff, Y_AXIS);
700 Interval extremal_positions;
701 extremal_positions.set_empty ();
702 for (vsize i = 0; i < columns.size (); i++)
704 Direction d = Note_column::dir (columns[i]);
705 extremal_positions[d] = minmax (d, 1.0 * Note_column::head_positions_interval (columns[i])[d], extremal_positions[d]);
707 for (LEFT_and_RIGHT (d))
708 extremal_positions[d] = -d * (staff_extent[d] - extremal_positions[d]);
710 return extremal_positions[UP] <= extremal_positions[DOWN] ? UP : DOWN;
713 return dirs[UP] > dirs[DOWN] ? UP : DOWN;
717 Tuplet_bracket::add_column (Grob *me, Item *n)
719 Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-columns"), n);
720 add_bound_item (dynamic_cast<Spanner *> (me), n);
724 Tuplet_bracket::add_script (Grob *me, Item *s)
726 Pointer_group_interface::add_grob (me, ly_symbol2scm ("scripts"), s);
730 Tuplet_bracket::add_tuplet_bracket (Grob *me, Grob *bracket)
732 Pointer_group_interface::add_grob (me, ly_symbol2scm ("tuplets"), bracket);
735 MAKE_SCHEME_CALLBACK (Tuplet_bracket, calc_cross_staff, 1);
737 Tuplet_bracket::calc_cross_staff (SCM smob)
739 Grob *me = unsmob<Grob> (smob);
740 extract_grob_set (me, "note-columns", cols);
741 extract_grob_set (me, "tuplets", tuplets);
743 Grob *commony = common_refpoint_of_array (cols, me, Y_AXIS);
744 commony = common_refpoint_of_array (tuplets, commony, Y_AXIS);
745 if (Grob *st = Staff_symbol_referencer::get_staff_symbol (me))
746 commony = st->common_refpoint (commony, Y_AXIS);
747 if (me->check_cross_staff (commony))
750 bool equally_long = false;
751 Grob *par_beam = parallel_beam (me, cols, &equally_long);
753 if (par_beam && to_boolean (par_beam->get_property ("cross-staff")))
756 for (vsize i = 0; i < cols.size (); i++)
758 Grob *stem = unsmob<Grob> (cols[i]->get_object ("stem"));
759 if (stem && to_boolean (stem->get_property ("cross-staff")))
766 ADD_INTERFACE (Tuplet_bracket,
767 "A bracket with a number in the middle, used for tuplets."
768 " When the bracket spans a line break, the value of"
769 " @code{break-overshoot} determines how far it extends"
770 " beyond the staff. At a line break, the markups in the"
771 " @code{edge-text} are printed at the edges.",
776 "bracket-visibility "
778 "connect-to-neighbor "
782 "full-length-padding "
783 "full-length-to-extent "