2 tuplet-bracket.cc -- implement Tuplet_bracket
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2004 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
26 #include "tuplet-bracket.hh"
30 #include "line-interface.hh"
33 #include "font-interface.hh"
34 #include "output-def.hh"
35 #include "text-item.hh"
37 #include "note-column.hh"
38 #include "group-interface.hh"
39 #include "directional-element-interface.hh"
41 #include "staff-symbol-referencer.hh"
45 get_x_bound_grob (Grob *g, Direction my_dir)
47 if (Note_column::get_stem (g)
48 && Note_column::dir (g) == my_dir)
50 g = Note_column::get_stem (g);
58 Tuplet_bracket::parallel_beam (Grob *me, Link_array<Grob> const &cols, bool *equally_long)
63 Grob *s1 = Note_column::get_stem (cols[0]);
64 Grob *s2 = Note_column::get_stem (cols.top ());
66 Grob*b1 = s1 ? Stem::get_beam (s1) : 0;
67 Grob*b2 = s2 ? Stem::get_beam (s2) : 0;
69 Spanner*sp = dynamic_cast<Spanner*> (me);
72 if (! (b1 && (b1 == b2) && !sp->is_broken ()))
75 Link_array<Grob> beam_stems = Pointer_group_interface__extract_grobs
76 (b1, (Grob*)0, "stems");
78 if (beam_stems.size () == 0)
80 programming_error ("Beam under tuplet bracket has no stems!");
85 *equally_long = (beam_stems[0] == s1 && beam_stems.top () == s2);
93 in the case that there is no bracket, but there is a (single) beam,
94 follow beam precisely for determining tuplet number location.
97 MAKE_SCHEME_CALLBACK (Tuplet_bracket,print,1);
99 Tuplet_bracket::print (SCM smob)
101 Grob *me= unsmob_grob (smob);
103 Link_array<Grob> columns=
104 Pointer_group_interface__extract_grobs (me, (Grob*)0, "note-columns");
106 if (!columns.size ())
107 return mol.smobbed_copy ();
112 SCM lp = me->get_property ("left-position");
113 SCM rp = me->get_property ("right-position");
115 if (!scm_is_number (rp) || !scm_is_number (lp))
116 after_line_breaking (smob);
119 Real ly = robust_scm2double (me->get_property ("left-position"), 0);
120 Real ry = robust_scm2double (me->get_property ("right-position"), 0);
122 bool equally_long = false;
123 Grob * par_beam = parallel_beam (me, columns, &equally_long);
125 Spanner*sp = dynamic_cast<Spanner*> (me);
127 bool bracket_visibility = !(par_beam && equally_long);
128 bool number_visibility = true;
131 Fixme: the type of this prop is sucky.
133 SCM bracket = me->get_property ("bracket-visibility");
134 if (scm_is_bool (bracket))
136 bracket_visibility = ly_scm2bool (bracket);
138 else if (bracket == ly_symbol2scm ("if-no-beam"))
139 bracket_visibility = !par_beam;
141 SCM numb = me->get_property ("number-visibility");
142 if (scm_is_bool (numb))
144 number_visibility = ly_scm2bool (numb);
146 else if (numb == ly_symbol2scm ("if-no-beam"))
147 number_visibility = !par_beam;
149 Grob * commonx = columns[0]->common_refpoint (columns.top (),X_AXIS);
152 Tuplet brackets are normally not broken, but we shouldn't crash if
155 commonx = commonx->common_refpoint (sp->get_bound (LEFT), X_AXIS);
156 commonx = commonx->common_refpoint (sp->get_bound (RIGHT), X_AXIS);
158 Direction dir = get_grob_direction (me);
160 Grob * lgr = get_x_bound_grob (columns[0], dir);
161 Grob * rgr = get_x_bound_grob (columns.top (), dir);
163 Real x0 = robust_relative_extent (lgr, commonx, X_AXIS)[LEFT];
164 Real x1 = robust_relative_extent (rgr, commonx, X_AXIS)[RIGHT];
167 SCM number = me->get_property ("text");
169 Output_def *pap = me->get_layout ();
171 if (scm_is_string (number) && number_visibility)
173 SCM properties = Font_interface::text_font_alist_chain (me);
174 SCM snum = Text_interface::interpret_markup (pap->self_scm (), properties, number);
175 num = *unsmob_stencil (snum);
176 num.align_to (X_AXIS, CENTER);
177 num.translate_axis (w/2, X_AXIS);
178 num.align_to (Y_AXIS, CENTER);
180 num.translate_axis ((ry-ly)/2, Y_AXIS);
182 mol.add_stencil (num);
187 No bracket when it would be smaller than the number.
189 TODO: should use GAP in calculation too.
191 if (bracket_visibility && number_visibility
192 && mol.extent (X_AXIS).length () > w)
194 bracket_visibility = false;
197 if (bracket_visibility)
199 Real ss = Staff_symbol_referencer::staff_space (me);
202 if (!num.extent (X_AXIS).is_empty ())
203 gap = num.extent (X_AXIS).length () + 1.0;
205 SCM fl = me->get_property ("bracket-flare");
206 SCM eh = me->get_property ("edge-height");
207 SCM sp = me->get_property ("shorten-pair");
210 Drul_array<Real> height, flare, shorten;
212 flare[d] = height[d] = shorten[d] = 0.0;
213 if (is_number_pair (fl))
214 flare[d] += ss * scm_to_double (index_get_cell (fl, d));
215 if (is_number_pair (eh))
216 height[d] += - dir * ss *scm_to_double (index_get_cell (eh, d));
217 if (is_number_pair (sp))
218 shorten[d] += ss *scm_to_double (index_get_cell (sp, d));
220 while (flip (&d) != LEFT);
222 Stencil brack = make_bracket (me, Y_AXIS,
226 0.1 = more space at right due to italics
227 TODO: use italic correction of font.
229 Interval (-0.5, 0.5) * gap + 0.1,
231 mol.add_stencil (brack);
234 mol.translate_axis (ly, Y_AXIS);
235 mol.translate_axis (x0 - sp->get_bound (LEFT)->relative_coordinate (commonx,X_AXIS),X_AXIS);
236 return mol.smobbed_copy ();
240 should move to lookup?
242 TODO: this will fail for very short (shorter than the flare)
246 Tuplet_bracket::make_bracket (Grob *me, // for line properties.
249 Drul_array<Real> height,
251 Drul_array<Real> flare,
252 Drul_array<Real> shorten)
254 Drul_array<Offset> corners (Offset (0,0), dz);
256 Real length = dz.length ();
257 Drul_array<Offset> gap_corners;
260 Axis bracket_axis = other_axis (protusion_axis);
262 Drul_array<Offset> straight_corners = corners;
266 straight_corners[d] += - d * shorten[d] /length * dz;
267 } while (flip (&d) != LEFT);
271 gap = Interval (0,0);
273 gap_corners[d] = (dz * 0.5) + gap[d] / length * dz;
274 } while (flip (&d) != LEFT);
276 Drul_array<Offset> flare_corners = straight_corners;
278 flare_corners[d][bracket_axis] = straight_corners[d][bracket_axis];
279 flare_corners[d][protusion_axis] += height[d];
280 straight_corners[d][bracket_axis] += - d * flare[d];
281 } while (flip (&d) != LEFT);
285 m.add_stencil (Line_interface::line (me, straight_corners[d],
288 m.add_stencil (Line_interface::line (me, straight_corners[d],
290 } while (flip (&d) != LEFT);
297 use first -> last note for slope, and then correct for disturbing
300 Tuplet_bracket::calc_position_and_height (Grob*me,Real *offset, Real * dy)
302 Link_array<Grob> columns=
303 Pointer_group_interface__extract_grobs (me, (Grob*)0, "note-columns");
306 SCM cols = me->get_property ("note-columns");
307 Grob * commony = common_refpoint_of_list (cols, me, Y_AXIS);
308 Grob * commonx = common_refpoint_of_list (cols, me, X_AXIS);
311 if (Grob * st = Staff_symbol_referencer::get_staff_symbol (me))
312 staff = st->extent (commony, Y_AXIS);
314 Direction dir = get_grob_direction (me);
317 Use outer non-rest columns to determine slope
320 while (l <columns.size () && Note_column::has_rests (columns[l]))
323 int r = columns.size ()- 1;
324 while (r >= l && Note_column::has_rests (columns[r]))
329 Interval rv =columns[r]->extent (commony, Y_AXIS);
330 Interval lv =columns[l]->extent (commony, Y_AXIS);
333 Real graphical_dy = rv[dir] - lv[dir];
335 Slice ls = Note_column::head_positions_interval (columns[l]);
336 Slice rs = Note_column::head_positions_interval (columns[r]);
339 musical_dy[UP] = rs[UP] - ls[UP];
340 musical_dy[DOWN] = rs[DOWN] - ls[DOWN];
341 if (sign (musical_dy[UP]) != sign (musical_dy[DOWN]))
343 else if (sign (graphical_dy) != sign (musical_dy[DOWN]))
352 *offset = - dir * infinity_f;
354 if (!columns.size ())
359 Grob * lgr = get_x_bound_grob (columns[0], dir);
360 Grob * rgr = get_x_bound_grob (columns.top (), dir);
361 Real x0 = robust_relative_extent (lgr, commonx, X_AXIS)[LEFT];
362 Real x1 = robust_relative_extent (rgr, commonx, X_AXIS)[RIGHT];
367 Real factor = columns.size () > 1 ? 1/ (x1 - x0) : 1.0;
369 for (int i = 0; i < columns.size (); i++)
371 Interval note_ext =columns[i]->extent (commony, Y_AXIS);
372 note_ext.unite (staff);
373 Real notey = note_ext[dir] - me->relative_coordinate (commony, Y_AXIS);
375 Real x = columns[i]->relative_coordinate (commonx, X_AXIS) - x0;
376 Real tuplety = *dy * x * factor;
378 if (notey * dir > (*offset + tuplety) * dir)
379 *offset = notey - tuplety;
383 *offset += scm_to_double (me->get_property ("padding")) *dir;
387 horizontal brackets should not collide with staff lines.
390 Real ss= Staff_symbol_referencer::staff_space (me);
391 if (*dy == 0 && fabs (*offset) < ss * Staff_symbol_referencer::staff_radius (me))
393 // quantize, then do collision check.
396 *offset = rint (*offset);
397 if (Staff_symbol_referencer::on_staffline (me, (int) rint (*offset)))
408 We depend on the beams if there are any.
410 MAKE_SCHEME_CALLBACK (Tuplet_bracket,before_line_breaking,1);
412 Tuplet_bracket::before_line_breaking (SCM smob)
414 Grob *me = unsmob_grob (smob);
415 Link_array<Grob> columns=
416 Pointer_group_interface__extract_grobs (me, (Grob*)0, "note-columns");
419 for (int i = columns.size (); i--;)
421 Grob * s =Note_column::get_stem (columns[i]);
422 Grob * b = s ? Stem::get_beam (s): 0;
424 me->add_dependency (b);
426 return SCM_UNSPECIFIED;
429 MAKE_SCHEME_CALLBACK (Tuplet_bracket,after_line_breaking,1);
432 Tuplet_bracket::after_line_breaking (SCM smob)
434 Grob * me = unsmob_grob (smob);
435 Link_array<Grob> columns=
436 Pointer_group_interface__extract_grobs (me, (Grob*)0, "note-columns");
438 if (!columns.size ())
441 return SCM_UNSPECIFIED;
443 if (dynamic_cast<Spanner*> (me)->is_broken ())
445 me->warning (_("Killing tuplet bracket across linebreak."));
447 return SCM_UNSPECIFIED;
450 Direction dir = get_grob_direction (me);
453 dir = Tuplet_bracket::get_default_dir (me);
454 set_grob_direction (me, dir);
457 bool equally_long = false;
458 Grob * par_beam = parallel_beam (me, columns, &equally_long);
461 We follow the beam only if there is one, and we are next to it.
465 || get_grob_direction (par_beam) != dir)
467 calc_position_and_height (me,&offset,&dy);
471 SCM ps = par_beam->get_property ("positions");
473 Real lp = scm_to_double (scm_car (ps));
474 Real rp = scm_to_double (scm_cdr (ps));
479 offset = lp + dir * (0.5 + scm_to_double (me->get_property ("padding")));
484 SCM lp = me->get_property ("left-position");
485 SCM rp = me->get_property ("right-position");
487 if (scm_is_number (lp) && !scm_is_number (rp))
489 rp = scm_make_real (scm_to_double (lp) + dy);
491 else if (scm_is_number (rp) && !scm_is_number (lp))
493 lp = scm_make_real (scm_to_double (rp) - dy);
495 else if (!scm_is_number (rp) && !scm_is_number (lp))
497 lp = scm_make_real (offset);
498 rp = scm_make_real (offset +dy);
501 me->set_property ("left-position", lp);
502 me->set_property ("right-position", rp);
504 return SCM_UNSPECIFIED;
512 Tuplet_bracket::get_default_dir (Grob*me)
514 Drul_array<int> dirs (0,0);
515 for (SCM s = me->get_property ("note-columns"); scm_is_pair (s); s = scm_cdr (s))
517 Grob * nc = unsmob_grob (scm_car (s));
518 Direction d = Note_column::dir (nc);
523 return dirs[UP] >= dirs[DOWN] ? UP : DOWN;
527 Tuplet_bracket::add_column (Grob*me, Item*n)
529 Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-columns"), n);
530 me->add_dependency (n);
532 add_bound_item (dynamic_cast<Spanner*> (me), n);
540 ADD_INTERFACE (Tuplet_bracket,"tuplet-bracket-interface",
541 "A bracket with a number in the middle, used for tuplets.",
542 "note-columns bracket-flare edge-height shorten-pair padding left-position right-position bracket-visibility number-visibility thickness direction");