2 plet-spanner.cc -- implement Tuplet_bracket
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2003 Jan Nieuwenhuizen <janneke@gnu.org>
12 - tuplet bracket should probably be subject to the same rules as
13 beam sloping/quanting.
15 - There is no support for kneed brackets, or nested brackets.
17 - number placement for parallel beams should be much more advanced:
18 for sloped beams some extra horizontal offset must be introduced.
20 - number placement is usually done over the center note, not the
27 #include "line-interface.hh"
31 #include "font-interface.hh"
32 #include "molecule.hh"
33 #include "paper-def.hh"
34 #include "text-item.hh"
35 #include "tuplet-bracket.hh"
37 #include "note-column.hh"
38 #include "group-interface.hh"
39 #include "directional-element-interface.hh"
41 #include "staff-symbol-referencer.hh"
46 get_x_bound_grob (Grob *g, Direction my_dir)
48 if (Note_column::get_stem (g)
49 && Note_column::dir (g) == my_dir)
51 g = Note_column::get_stem (g);
59 Tuplet_bracket::parallel_beam (Grob *me, Link_array<Grob> const &cols, bool *equally_long)
64 Grob *s1 = Note_column::get_stem (cols[0]);
65 Grob *s2 = Note_column::get_stem (cols.top());
67 Grob*b1 = s1 ? Stem::get_beam (s1) : 0;
68 Grob*b2 = s2 ? Stem::get_beam (s2) : 0;
70 Spanner*sp = dynamic_cast<Spanner*> (me);
73 if (! (b1 && (b1 == b2) && !sp->broken_b()))
76 Link_array<Grob> beam_stems = Pointer_group_interface__extract_grobs
77 (b1, (Grob*)0, "stems");
79 if (beam_stems.size() == 0)
81 programming_error ("Beam under tuplet bracket has no stems!");
86 *equally_long = (beam_stems[0] == s1 && beam_stems.top() == s2);
94 in the case that there is no bracket, but there is a (single) beam,
95 follow beam precisely for determining tuplet number location.
98 MAKE_SCHEME_CALLBACK (Tuplet_bracket,brew_molecule,1);
100 Tuplet_bracket::brew_molecule (SCM smob)
102 Grob *me= unsmob_grob (smob);
104 Link_array<Grob> columns=
105 Pointer_group_interface__extract_grobs (me, (Grob*)0, "note-columns");
107 if (!columns.size ())
108 return mol.smobbed_copy ();
113 SCM lp = me->get_grob_property ("left-position");
114 SCM rp = me->get_grob_property ("right-position");
116 if (!gh_number_p (rp) || !gh_number_p (lp))
117 after_line_breaking (smob);
120 Real ly = robust_scm2double (me->get_grob_property ("left-position"), 0);
121 Real ry = robust_scm2double (me->get_grob_property ("right-position"), 0);
123 bool equally_long = false;
124 Grob * par_beam = parallel_beam (me, columns, &equally_long);
126 Spanner*sp = dynamic_cast<Spanner*> (me);
128 bool bracket_visibility = !(par_beam && equally_long);
129 bool number_visibility = true;
132 Fixme: the type of this prop is sucky.
134 SCM bracket = me->get_grob_property ("bracket-visibility");
135 if (gh_boolean_p (bracket))
137 bracket_visibility = gh_scm2bool (bracket);
139 else if (bracket == ly_symbol2scm ("if-no-beam"))
140 bracket_visibility = !par_beam;
142 SCM numb = me->get_grob_property ("number-visibility");
143 if (gh_boolean_p (numb))
145 number_visibility = gh_scm2bool (numb);
147 else if (numb == ly_symbol2scm ("if-no-beam"))
148 number_visibility = !par_beam;
150 Grob * commonx = columns[0]->common_refpoint (columns.top (),X_AXIS);
153 Tuplet brackets are normally not broken, but we shouldn't crash if
156 commonx = commonx->common_refpoint (sp->get_bound(LEFT), X_AXIS);
157 commonx = commonx->common_refpoint (sp->get_bound(RIGHT), X_AXIS);
159 Direction dir = get_grob_direction (me);
161 Grob * lgr = get_x_bound_grob (columns[0], dir);
162 Grob * rgr = get_x_bound_grob (columns.top(), dir);
163 Real x0 = lgr->extent (commonx,X_AXIS)[LEFT];
164 Real x1 = rgr->extent (commonx,X_AXIS)[RIGHT];
168 SCM number = me->get_grob_property ("text");
170 Paper_def *pap = me->get_paper ();
171 if (gh_string_p (number) && number_visibility)
173 SCM properties = Font_interface::font_alist_chain (me);
174 SCM snum = Text_item::interpret_markup (pap->self_scm (), properties, number);
175 Molecule num = *unsmob_molecule (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_molecule (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 SCM gap = me->get_grob_property ("gap");
201 SCM fl = me->get_grob_property ("bracket-flare");
202 SCM eh = me->get_grob_property ("edge-height");
203 SCM sp = me->get_grob_property ("shorten-pair");
206 Drul_array<Real> height, flare, shorten;
208 flare[d] = height[d] = shorten[d] = 0.0;
209 if (is_number_pair (fl))
210 flare[d] += gh_scm2double (index_get_cell (fl, d));
211 if (is_number_pair (eh))
212 height[d] += gh_scm2double (index_get_cell (eh, d)) * - dir;
213 if (is_number_pair (sp))
214 shorten[d] += gh_scm2double (index_get_cell (sp, d));
216 while (flip (&d) != LEFT);
218 Molecule brack = make_bracket (me, Y_AXIS,
224 mol.add_molecule (brack);
227 mol.translate_axis (ly, Y_AXIS);
228 mol.translate_axis (x0 - sp->get_bound (LEFT)->relative_coordinate (commonx,X_AXIS),X_AXIS);
229 return mol.smobbed_copy ();
233 should move to lookup?
235 TODO: this will fail for very short (shorter than the flare)
239 Tuplet_bracket::make_bracket (Grob *me, // for line properties.
242 Drul_array<Real> height,
244 Drul_array<Real> flare,
245 Drul_array<Real> shorten)
247 Drul_array<Offset> corners (Offset(0,0), dz);
249 Real length = dz.length ();
250 Drul_array<Offset> gap_corners;
253 Axis bracket_axis = other_axis (protusion_axis);
255 Drul_array<Offset> straight_corners = corners;
259 straight_corners[d] += - d * shorten[d] /length * dz;
260 gap_corners[d] = (dz * 0.5) + d * gap / length * dz;
261 } while (flip (&d) != LEFT);
263 Drul_array<Offset> flare_corners = straight_corners;
265 flare_corners[d][bracket_axis] = straight_corners[d][bracket_axis];
266 flare_corners[d][protusion_axis] += height[d];
267 straight_corners[d][bracket_axis] += - d * flare[d];
268 } while (flip (&d) != LEFT);
272 m.add_molecule (Line_interface::line (me, straight_corners[d],
275 m.add_molecule (Line_interface::line (me, straight_corners[d],
277 } while (flip (&d) != LEFT);
284 use first -> last note for slope, and then correct for disturbing
287 Tuplet_bracket::calc_position_and_height (Grob*me,Real *offset, Real * dy)
289 Link_array<Grob> columns=
290 Pointer_group_interface__extract_grobs (me, (Grob*)0, "note-columns");
293 SCM cols = me->get_grob_property ("note-columns");
294 Grob * commony = common_refpoint_of_list (cols, me, Y_AXIS);
295 Grob * commonx = common_refpoint_of_list (cols, me, X_AXIS);
299 if (Grob * st = Staff_symbol_referencer::get_staff_symbol (me))
300 staff = st->extent (commony, Y_AXIS);
302 Direction dir = get_grob_direction (me);
305 Use outer non-rest columns to determine slope
308 while (l <columns.size () && Note_column::rest_b (columns[l]))
311 int r = columns.size ()- 1;
312 while (r >= l && Note_column::rest_b (columns[r]))
317 Interval rv =columns[r]->extent (commony, Y_AXIS);
318 Interval lv =columns[l]->extent (commony, Y_AXIS);
321 Real graphical_dy = rv[dir] - lv[dir];
323 Slice ls = Note_column::head_positions_interval (columns[l]);
324 Slice rs = Note_column::head_positions_interval (columns[r]);
327 musical_dy[UP] = rs[UP] - ls[UP];
328 musical_dy[DOWN] = rs[DOWN] - ls[DOWN];
329 if (sign (musical_dy[UP]) != sign (musical_dy[DOWN]))
331 else if (sign (graphical_dy) != sign (musical_dy[DOWN]))
340 *offset = - dir * infinity_f;
342 if (!columns.size ())
347 Grob * lgr = get_x_bound_grob (columns[0], dir);
348 Grob * rgr = get_x_bound_grob (columns.top(), dir);
349 Real x0 = lgr->extent (commonx,X_AXIS)[LEFT];
350 Real x1 = rgr->extent (commonx,X_AXIS)[RIGHT];
356 Real factor = columns.size () > 1 ? 1/ (x1 - x0) : 1.0;
358 for (int i = 0; i < columns.size (); i++)
360 Interval note_ext =columns[i]->extent (commony, Y_AXIS);
361 note_ext.unite (staff);
362 Real notey = note_ext[dir] - me->relative_coordinate (commony, Y_AXIS);
364 Real x = columns[i]->relative_coordinate (commonx, X_AXIS) - x0;
365 Real tuplety = *dy * x * factor;
367 if (notey * dir > (*offset + tuplety) * dir)
368 *offset = notey - tuplety;
372 *offset += gh_scm2double (me->get_grob_property ("padding")) *dir;
376 horizontal brackets should not collide with staff lines.
379 Real ss= Staff_symbol_referencer::staff_space (me);
380 if (*dy == 0 && fabs (*offset) < ss * Staff_symbol_referencer::staff_radius (me))
382 // quantize, then do collision check.
385 *offset = rint (*offset);
386 if (Staff_symbol_referencer::on_staffline (me, (int) rint (*offset)))
397 We depend on the beams if there are any.
399 MAKE_SCHEME_CALLBACK (Tuplet_bracket,before_line_breaking,1);
401 Tuplet_bracket::before_line_breaking (SCM smob)
403 Grob *me = unsmob_grob (smob);
404 Link_array<Grob> columns=
405 Pointer_group_interface__extract_grobs (me, (Grob*)0, "note-columns");
408 for (int i = columns.size(); i--;)
410 Grob * s =Note_column::get_stem (columns[i]);
411 Grob * b = s ? Stem::get_beam (s): 0;
413 me->add_dependency (b);
415 return SCM_UNDEFINED;
418 MAKE_SCHEME_CALLBACK (Tuplet_bracket,after_line_breaking,1);
421 Tuplet_bracket::after_line_breaking (SCM smob)
423 Grob * me = unsmob_grob (smob);
424 Link_array<Grob> columns=
425 Pointer_group_interface__extract_grobs (me, (Grob*)0, "note-columns");
427 if (!columns.size ())
430 return SCM_UNSPECIFIED;
432 if (dynamic_cast<Spanner*> (me)->broken_b ())
434 me->warning (_("Killing tuplet bracket across linebreak."));
436 return SCM_UNSPECIFIED;
439 Direction dir = get_grob_direction (me);
442 dir = Tuplet_bracket::get_default_dir (me);
443 set_grob_direction (me, dir);
446 bool equally_long = false;
447 Grob * par_beam = parallel_beam (me, columns, &equally_long);
450 We follow the beam only if there is one, and we are next to it.
454 || get_grob_direction (par_beam) != dir)
456 calc_position_and_height (me,&offset,&dy);
460 SCM ps = par_beam->get_grob_property ("positions");
462 Real lp = gh_scm2double (gh_car (ps));
463 Real rp = gh_scm2double (gh_cdr (ps));
468 offset = lp + dir * (0.5 + gh_scm2double (me->get_grob_property ("padding")));
473 SCM lp = me->get_grob_property ("left-position");
474 SCM rp = me->get_grob_property ("right-position");
476 if (gh_number_p (lp) && !gh_number_p (rp))
478 rp = gh_double2scm (gh_scm2double (lp) + dy);
480 else if (gh_number_p (rp) && !gh_number_p (lp))
482 lp = gh_double2scm (gh_scm2double (rp) - dy);
484 else if (!gh_number_p (rp) && !gh_number_p (lp))
486 lp = gh_double2scm (offset);
487 rp = gh_double2scm (offset +dy);
490 me->set_grob_property ("left-position", lp);
491 me->set_grob_property ("right-position", rp);
493 return SCM_UNSPECIFIED;
501 Tuplet_bracket::get_default_dir (Grob*me)
503 Drul_array<int> dirs(0,0);
504 for (SCM s = me->get_grob_property ("note-columns"); gh_pair_p (s); s = ly_cdr (s))
506 Grob * nc = unsmob_grob (ly_car (s));
509 dirs[Note_column::dir (nc)]++;
512 return dirs[UP] >= dirs[DOWN] ? UP : DOWN;
516 Tuplet_bracket::add_column (Grob*me, Item*n)
518 Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-columns"), n);
519 me->add_dependency (n);
521 add_bound_item (dynamic_cast<Spanner*> (me), n);
529 ADD_INTERFACE (Tuplet_bracket,"tuplet-bracket-interface",
530 "A bracket with a number in the middle, used for tuplets.",
531 "note-columns bracket-flare edge-height shorten-pair padding gap left-position right-position bracket-visibility number-visibility thickness direction");