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
30 #include "font-interface.hh"
31 #include "molecule.hh"
32 #include "paper-def.hh"
33 #include "text-item.hh"
34 #include "tuplet-bracket.hh"
36 #include "note-column.hh"
37 #include "group-interface.hh"
38 #include "directional-element-interface.hh"
40 #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->broken_b()))
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,brew_molecule,1);
99 Tuplet_bracket::brew_molecule (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 ();
109 bool equally_long = false;
110 Grob * par_beam = parallel_beam (me, columns, &equally_long);
112 Spanner*sp = dynamic_cast<Spanner*> (me);
114 bool bracket_visibility = !(par_beam && equally_long);
115 bool number_visibility = true;
118 Fixme: the type of this prop is sucky.
120 SCM bracket = me->get_grob_property ("bracket-visibility");
121 if (gh_boolean_p (bracket))
123 bracket_visibility = gh_scm2bool (bracket);
125 else if (bracket == ly_symbol2scm ("if-no-beam"))
126 bracket_visibility = !par_beam;
128 SCM numb = me->get_grob_property ("number-visibility");
129 if (gh_boolean_p (numb))
131 number_visibility = gh_scm2bool (numb);
133 else if (numb == ly_symbol2scm ("if-no-beam"))
134 number_visibility = !par_beam;
136 Grob * commonx = columns[0]->common_refpoint (columns.top (),X_AXIS);
139 Tuplet brackets are normally not broken, but we shouldn't crash if
142 commonx = commonx->common_refpoint (sp->get_bound(LEFT), X_AXIS);
143 commonx = commonx->common_refpoint (sp->get_bound(RIGHT), X_AXIS);
145 Direction dir = Directional_element_interface::get (me);
147 Grob * lgr = get_x_bound_grob (columns[0], dir);
148 Grob * rgr = get_x_bound_grob (columns.top(), dir);
149 Real x0 = lgr->extent (commonx,X_AXIS)[LEFT];
150 Real x1 = rgr->extent (commonx,X_AXIS)[RIGHT];
154 Real ly = gh_scm2double (me->get_grob_property ("left-position"));
155 Real ry = gh_scm2double (me->get_grob_property ("right-position"));
156 SCM number = me->get_grob_property ("text");
158 if (gh_string_p (number) && number_visibility)
160 SCM properties = Font_interface::font_alist_chain (me);
161 SCM snum = Text_item::interpret_markup (smob, properties, number);
162 Molecule num = *unsmob_molecule (snum);
163 num.align_to (X_AXIS, CENTER);
164 num.translate_axis (w/2, X_AXIS);
165 num.align_to (Y_AXIS, CENTER);
167 num.translate_axis ((ry-ly)/2, Y_AXIS);
169 mol.add_molecule (num);
172 if (bracket_visibility)
174 Real lt = me->get_paper ()->get_realvar (ly_symbol2scm ("linethickness"));
176 SCM thick = me->get_grob_property ("thickness");
177 if (gh_number_p (thick))
178 lt *= gh_scm2double (thick);
180 SCM gap = me->get_grob_property ("gap");
181 SCM fl = me->get_grob_property ("bracket-flare");
182 SCM eh = me->get_grob_property ("edge-height");
183 SCM sp = me->get_grob_property ("shorten-pair");
186 Drul_array<Real> height, flare, shorten;
188 flare[d] = height[d] = shorten[d] = 0.0;
189 if (ly_number_pair_p (fl))
190 flare[d] += gh_scm2double (index_get_cell (fl, d));
191 if (ly_number_pair_p (eh))
192 height[d] += gh_scm2double (index_get_cell (eh, d)) * - dir;
193 if (ly_number_pair_p (sp))
194 shorten[d] += gh_scm2double (index_get_cell (sp, d));
196 while (flip (&d) != LEFT);
198 Molecule brack = make_bracket (Y_AXIS,
204 mol.add_molecule (brack);
207 mol.translate_axis (ly, Y_AXIS);
208 mol.translate_axis (x0 - sp->get_bound (LEFT)->relative_coordinate (commonx,X_AXIS),X_AXIS);
209 return mol.smobbed_copy ();
213 should move to lookup?
215 TODO: this will fail for very short (shorter than the flare)
219 Tuplet_bracket::make_bracket (Axis protusion_axis,
220 Real dx, Real dy, Real thick, Drul_array<Real> height,
222 Drul_array<Real> flare,
223 Drul_array<Real> shorten)
225 Offset dz = Offset (dx,dy);
226 Drul_array<Offset> corners (Offset(0,0), dz);
228 Real length = dz.length ();
229 Drul_array<Offset> gap_corners;
232 Axis bracket_axis = other_axis (protusion_axis);
234 Drul_array<Offset> straight_corners = corners;
238 straight_corners[d] += - d * shorten[d] /length * dz;
239 gap_corners[d] = (dz * 0.5) + d * gap / length * dz;
240 } while (flip (&d) != LEFT);
242 Drul_array<Offset> flare_corners = straight_corners;
244 flare_corners[d][bracket_axis] = straight_corners[d][bracket_axis];
245 flare_corners[d][protusion_axis] += height[d];
246 straight_corners[d][bracket_axis] += - d * flare[d];
247 } while (flip (&d) != LEFT);
252 m.add_molecule (Lookup::line (thick, straight_corners[d],
255 m.add_molecule (Lookup::line (thick, straight_corners[d],
257 } while (flip (&d) != LEFT);
264 use first -> last note for slope, and then correct for disturbing
267 Tuplet_bracket::calc_position_and_height (Grob*me,Real *offset, Real * dy)
269 Link_array<Grob> columns=
270 Pointer_group_interface__extract_grobs (me, (Grob*)0, "note-columns");
273 SCM cols = me->get_grob_property ("note-columns");
274 Grob * commony = common_refpoint_of_list (cols, me, Y_AXIS);
275 Grob * commonx = common_refpoint_of_list (cols, me, X_AXIS);
277 Direction dir = Directional_element_interface::get (me);
280 Use outer non-rest columns to determine slope
283 while (l <columns.size () && Note_column::rest_b (columns[l]))
286 int r = columns.size ()- 1;
287 while (r >= l && Note_column::rest_b (columns[r]))
292 *dy = columns[r]->extent (commony, Y_AXIS) [dir]
293 - columns[l]->extent (commony, Y_AXIS) [dir] ;
299 *offset = - dir * infinity_f;
301 if (!columns.size ())
306 Grob * lgr = get_x_bound_grob (columns[0], dir);
307 Grob * rgr = get_x_bound_grob (columns.top(), dir);
308 Real x0 = lgr->extent (commonx,X_AXIS)[LEFT];
309 Real x1 = rgr->extent (commonx,X_AXIS)[RIGHT];
315 Real factor = columns.size () > 1 ? 1/ (x1 - x0) : 1.0;
317 for (int i = 0; i < columns.size (); i++)
319 Real notey = columns[i]->extent (commony, Y_AXIS)[dir]
320 - me->relative_coordinate (commony, Y_AXIS);
322 Real x = columns[i]->relative_coordinate (commonx, X_AXIS) - x0;
323 Real tuplety = *dy * x * factor;
325 if (notey * dir > (*offset + tuplety) * dir)
326 *offset = notey - tuplety;
330 *offset += gh_scm2double (me->get_grob_property ("padding")) *dir;
334 horizontal brackets should not collide with staff lines.
337 Real ss= Staff_symbol_referencer::staff_space (me);
338 if (*dy == 0 && fabs (*offset) < ss * Staff_symbol_referencer::staff_radius (me))
340 // quantize, then do collision check.
343 *offset = rint (*offset);
344 if (Staff_symbol_referencer::on_staffline (me, (int) rint (*offset)))
353 use first -> last note for slope,
356 Tuplet_bracket::calc_dy (Grob*me,Real * dy)
358 Link_array<Grob> columns=
359 Pointer_group_interface__extract_grobs (me, (Grob*)0, "note-columns");
364 Direction d = Directional_element_interface::get (me);
365 *dy = columns.top ()->extent (columns.top (), Y_AXIS) [d]
366 - columns[0]->extent (columns[0], Y_AXIS) [d];
371 We depend on the beams if there are any.
373 MAKE_SCHEME_CALLBACK (Tuplet_bracket,before_line_breaking,1);
375 Tuplet_bracket::before_line_breaking (SCM smob)
377 Grob *me = unsmob_grob (smob);
378 Link_array<Grob> columns=
379 Pointer_group_interface__extract_grobs (me, (Grob*)0, "note-columns");
382 for (int i = columns.size(); i--;)
384 Grob * s =Note_column::get_stem (columns[i]);
385 Grob * b = s ? Stem::get_beam (s): 0;
387 me->add_dependency (b);
389 return SCM_UNDEFINED;
392 MAKE_SCHEME_CALLBACK (Tuplet_bracket,after_line_breaking,1);
395 Tuplet_bracket::after_line_breaking (SCM smob)
397 Grob * me = unsmob_grob (smob);
398 Link_array<Grob> columns=
399 Pointer_group_interface__extract_grobs (me, (Grob*)0, "note-columns");
401 if (!columns.size ())
404 return SCM_UNSPECIFIED;
406 if (dynamic_cast<Spanner*> (me)->broken_b ())
408 me->warning ("Tuplet_bracket was across linebreak. Farewell cruel world.");
410 return SCM_UNSPECIFIED;
413 Direction dir = Directional_element_interface::get (me);
416 dir = Tuplet_bracket::get_default_dir (me);
417 Directional_element_interface::set (me, dir);
420 bool equally_long = false;
421 Grob * par_beam = parallel_beam (me, columns, &equally_long);
424 We follow the beam only if there is one, and we are next to it.
428 || Directional_element_interface::get (par_beam) != dir)
430 calc_position_and_height (me,&offset,&dy);
434 SCM ps = par_beam->get_grob_property ("positions");
436 Real lp = gh_scm2double (gh_car (ps));
437 Real rp = gh_scm2double (gh_cdr (ps));
442 offset = lp + dir * (0.5 + gh_scm2double (me->get_grob_property ("padding")));
447 SCM lp = me->get_grob_property ("left-position");
448 SCM rp = me->get_grob_property ("right-position");
450 if (gh_number_p (lp) && !gh_number_p (rp))
452 rp = gh_double2scm (gh_scm2double (lp) + dy);
454 else if (gh_number_p (rp) && !gh_number_p (lp))
456 lp = gh_double2scm (gh_scm2double (rp) - dy);
458 else if (!gh_number_p (rp) && !gh_number_p (lp))
460 lp = gh_double2scm (offset);
461 rp = gh_double2scm (offset +dy);
464 me->set_grob_property ("left-position", lp);
465 me->set_grob_property ("right-position", rp);
467 return SCM_UNSPECIFIED;
475 Tuplet_bracket::get_default_dir (Grob*me)
478 for (SCM s = me->get_grob_property ("note-columns"); gh_pair_p (s); s = ly_cdr (s))
480 Grob * nc = unsmob_grob (ly_car (s));
481 if (Note_column::dir (nc) < 0)
491 Tuplet_bracket::add_column (Grob*me, Item*n)
493 Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-columns"), n);
494 me->add_dependency (n);
496 add_bound_item (dynamic_cast<Spanner*> (me), n);
504 ADD_INTERFACE (Tuplet_bracket,"tuplet-bracket-interface",
505 "A bracket with a number in the middle, used for tuplets.",
506 "note-columns bracket-flare edge-height shorten-pair padding gap left-position right-position bracket-visibility number-visibility thickness direction");