lily/tuplet-bracket.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2015 Jan Nieuwenhuizen <janneke@gnu.org>
   5   Han-Wen Nienhuys <hanwen@xs4all.nl>
   6
   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.
  11
  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.
  16
  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/>.
  19 */
  20
  21 /*
  22   TODO:
  23
  24   - tuplet bracket should probably be subject to the same rules as
  25   beam sloping/quanting.
  26
  27   - There is no support for kneed brackets, or nested brackets.
  28
  29   - number placement for parallel beams should be much more advanced:
  30   for sloped beams some extra horizontal offset must be introduced.
  31
  32   - number placement is usually done over the center note, not the
  33   graphical center.
  34 */
  35
  36 /*
  37   TODO: quantise, we don't want to collide with staff lines.
  38   (or should we be above staff?)
  39
  40   todo: handle breaking elegantly.
  41 */
  42
  43 #include "tuplet-bracket.hh"
  44 #include "axis-group-interface.hh"
  45 #include "line-interface.hh"
  46 #include "beam.hh"
  47 #include "warn.hh"
  48 #include "output-def.hh"
  49 #include "font-interface.hh"
  50 #include "text-interface.hh"
  51 #include "stem.hh"
  52 #include "note-column.hh"
  53 #include "pointer-group-interface.hh"
  54 #include "directional-element-interface.hh"
  55 #include "skyline.hh"
  56 #include "spanner.hh"
  57 #include "staff-symbol-referencer.hh"
  58 #include "lookup.hh"
  59 #include "paper-column.hh"
  60 #include "moment.hh"
  61
  62 static Item *
  63 get_x_bound_item (Grob *me_grob, Direction hdir, Direction my_dir)
  64 {
  65   Spanner *me = dynamic_cast<Spanner *> (me_grob);
  66   Item *g = me->get_bound (hdir);
  67   if (has_interface<Note_column> (g)
  68       && Note_column::get_stem (g)
  69       && Note_column::dir (g) == my_dir)
  70     g = Note_column::get_stem (g);
  71
  72   return g;
  73 }
  74
  75 void
  76 flatten_number_pair_property (Grob *me, Direction xdir, SCM sym)
  77 {
  78   Drul_array<Real> zero (0, 0);
  79   Drul_array<Real> pair
  80     = robust_scm2drul (me->get_property (sym), zero);
  81   pair[xdir] = 0.0;
  82
  83   me->set_property (sym, ly_interval2scm (pair));
  84 }
  85
  86 /*
  87   Return beam that encompasses the span of the tuplet bracket.
  88 */
  89 Grob *
  90 Tuplet_bracket::parallel_beam (Grob *me_grob, vector<Grob *> const &cols,
  91                                bool *equally_long)
  92 {
  93   Spanner *me = dynamic_cast<Spanner *> (me_grob);
  94
  95   Item *left = me->get_bound (LEFT);
  96   Item *right = me->get_bound (RIGHT);
  97   if (!left || left->break_status_dir ()
  98       || !right || right->break_status_dir ())
  99     return 0;
 100
 101   Drul_array<Grob *> stems (Note_column::get_stem (cols[0]),
 102                             Note_column::get_stem (cols.back ()));
 103
 104   if (!stems[RIGHT]
 105       || !stems[LEFT]
 106       || (dynamic_cast<Item *> (stems[RIGHT])->get_column ()
 107           != me->get_bound (RIGHT)->get_column ()))
 108     return 0;
 109
 110   Drul_array<Grob *> beams;
 111   for (LEFT_and_RIGHT (d))
 112     beams[d] = stems[d] ? Stem::get_beam (stems[d]) : 0;
 113
 114   *equally_long = false;
 115   if (! (beams[LEFT] && (beams[LEFT] == beams[RIGHT]) && !me->is_broken ()))
 116     return 0;
 117
 118   extract_grob_set (beams[LEFT], "stems", beam_stems);
 119   if (beam_stems.size () == 0)
 120     {
 121       programming_error ("beam under tuplet bracket has no stems");
 122       *equally_long = 0;
 123       return 0;
 124     }
 125
 126   *equally_long
 127     = (beam_stems[0] == stems[LEFT]
 128        && beam_stems.back () == stems[RIGHT]);
 129   return beams[LEFT];
 130 }
 131
 132 MAKE_SCHEME_CALLBACK (Tuplet_bracket, calc_connect_to_neighbors, 1);
 133 SCM
 134 Tuplet_bracket::calc_connect_to_neighbors (SCM smob)
 135 {
 136   Spanner *me = unsmob<Spanner> (smob);
 137
 138   Direction dir = get_grob_direction (me);
 139   Drul_array<Item *> bounds (get_x_bound_item (me, LEFT, dir),
 140                              get_x_bound_item (me, RIGHT, dir));
 141
 142   Drul_array<bool> connect_to_other (false, false);
 143   for (LEFT_and_RIGHT (d))
 144     {
 145       Direction break_dir = bounds[d]->break_status_dir ();
 146       Spanner *orig_spanner = dynamic_cast<Spanner *> (me->original ());
 147       vsize neighbor_idx = me->get_break_index () - break_dir;
 148       if (break_dir
 149           && d == RIGHT
 150           && neighbor_idx < orig_spanner->broken_intos_.size ())
 151         {
 152           Grob *neighbor = orig_spanner->broken_intos_[neighbor_idx];
 153
 154           /* trigger possible suicide*/
 155           (void) neighbor->get_property ("positions");
 156         }
 157
 158       connect_to_other[d]
 159         = (break_dir
 160            && neighbor_idx < orig_spanner->broken_intos_.size ()
 161            && orig_spanner->broken_intos_[neighbor_idx]->is_live ());
 162     }
 163
 164   if (connect_to_other[LEFT] || connect_to_other[RIGHT])
 165     return scm_cons (scm_from_bool (connect_to_other[LEFT]),
 166                      scm_from_bool (connect_to_other[RIGHT]));
 167
 168   return SCM_EOL;
 169 }
 170
 171 Grob *
 172 Tuplet_bracket::get_common_x (Spanner *me)
 173 {
 174   extract_grob_set (me, "note-columns", columns);
 175
 176   Grob *commonx = common_refpoint_of_array (columns, me, X_AXIS);
 177   commonx = commonx->common_refpoint (me->get_bound (LEFT), X_AXIS);
 178   commonx = commonx->common_refpoint (me->get_bound (RIGHT), X_AXIS);
 179
 180   return commonx;
 181 }
 182
 183 MAKE_SCHEME_CALLBACK (Tuplet_bracket, calc_x_positions, 1)
 184 SCM
 185 Tuplet_bracket::calc_x_positions (SCM smob)
 186 {
 187   Spanner *me = unsmob<Spanner> (smob);
 188   extract_grob_set (me, "note-columns", columns);
 189
 190   Grob *commonx = get_common_x (me);
 191   Direction dir = get_grob_direction (me);
 192
 193   Drul_array<Item *> bounds;
 194   bounds[LEFT] = get_x_bound_item (me, LEFT, dir);
 195   bounds[RIGHT] = get_x_bound_item (me, RIGHT, dir);
 196
 197   Drul_array<bool> connect_to_other
 198     = robust_scm2booldrul (me->get_property ("connect-to-neighbor"),
 199                            Drul_array<bool> (false, false));
 200
 201   Interval x_span;
 202   for (LEFT_and_RIGHT (d))
 203     {
 204       x_span[d] = Axis_group_interface::generic_bound_extent (bounds[d], commonx, X_AXIS)[d];
 205
 206       if (connect_to_other[d])
 207         {
 208           Interval overshoot (robust_scm2drul (me->get_property ("break-overshoot"),
 209                                                Interval (-0.5, 0.0)));
 210
 211           if (d == RIGHT)
 212             x_span[d] += d * overshoot[d];
 213           else
 214             x_span[d] = (bounds[d]->break_status_dir ()
 215                          ? Axis_group_interface::generic_bound_extent (bounds[d], commonx, X_AXIS)[-d]
 216                          : robust_relative_extent (bounds[d], commonx, X_AXIS)[-d])
 217                         - overshoot[LEFT];
 218         }
 219
 220       else if (d == RIGHT
 221                && (columns.empty ()
 222                    || (bounds[d]->get_column ()
 223                        != dynamic_cast<Item *> (columns.back ())->get_column ())))
 224         {
 225           /*
 226             We're connecting to a column, for the last bit of a broken
 227             fullLength bracket.
 228           */
 229           Real padding
 230             = robust_scm2double (me->get_property ("full-length-padding"), 1.0);
 231
 232           if (bounds[d]->break_status_dir ())
 233             padding = 0.0;
 234
 235           Real coord = bounds[d]->relative_coordinate (commonx, X_AXIS);
 236           if (to_boolean (me->get_property ("full-length-to-extent")))
 237             coord = robust_relative_extent (bounds[d], commonx, X_AXIS)[LEFT];
 238
 239           coord = max (coord, x_span[LEFT]);
 240
 241           x_span[d] = coord - padding;
 242         }
 243     }
 244
 245   return ly_interval2scm (x_span - me->get_bound (LEFT)->relative_coordinate (commonx, X_AXIS));
 246 }
 247
 248 /*
 249   TODO:
 250
 251   in the case that there is no bracket, but there is a (single) beam,
 252   follow beam precisely for determining tuplet number location.
 253 */
 254 MAKE_SCHEME_CALLBACK (Tuplet_bracket, print, 1);
 255 SCM
 256 Tuplet_bracket::print (SCM smob)
 257 {
 258   Spanner *me = unsmob<Spanner> (smob);
 259   Stencil mol;
 260
 261   extract_grob_set (me, "note-columns", columns);
 262   bool equally_long = false;
 263   Grob *par_beam = parallel_beam (me, columns, &equally_long);
 264
 265   bool bracket_visibility = !(par_beam && equally_long); // Flag, print/don't print tuplet bracket.
 266   /*
 267     FIXME: The type of this prop is sucky.
 268   */
 269   SCM bracket_vis_prop = me->get_property ("bracket-visibility");
 270   bool bracket_prop = ly_scm2bool (bracket_vis_prop); // Flag, user has set bracket-visibility prop.
 271   bool bracket = scm_is_eq (bracket_vis_prop, ly_symbol2scm ("if-no-beam"));
 272   if (scm_is_bool (bracket_vis_prop))
 273     bracket_visibility = bracket_prop;
 274   else if (bracket)
 275     bracket_visibility = !par_beam;
 276
 277   /*
 278     Don't print a tuplet bracket and number if
 279     no X or Y positions were calculated.
 280   */
 281   SCM scm_x_span = me->get_property ("X-positions");
 282   SCM scm_positions = me->get_property ("positions");
 283   if (!scm_is_pair (scm_x_span) || !scm_is_pair (scm_positions))
 284     {
 285       me->suicide ();
 286       return SCM_EOL;
 287     }
 288   /*  if the tuplet does not span any time, i.e. a single-note tuplet, hide
 289       the bracket, but still let the number be displayed.
 290       Only do this if the user has not explicitly specified bracket-visibility = #t.
 291   */
 292   if (!to_boolean (bracket_vis_prop)
 293       && (robust_scm2moment (me->get_bound (LEFT)->get_column ()->get_property ("when"), Moment (0))
 294           == robust_scm2moment (me->get_bound (RIGHT)->get_column ()->get_property ("when"), Moment (0))))
 295     bracket_visibility = false;
 296
 297   Interval x_span = robust_scm2interval (scm_x_span, Interval (0.0, 0.0));
 298   Interval positions = robust_scm2interval (scm_positions, Interval (0.0, 0.0));
 299
 300   Drul_array<Offset> points;
 301   for (LEFT_and_RIGHT (d))
 302     points[d] = Offset (x_span[d], positions[d]);
 303
 304   Output_def *pap = me->layout ();
 305
 306   Grob *number_grob = unsmob<Grob> (me->get_object ("tuplet-number"));
 307
 308   /*
 309     Don't print the bracket when it would be smaller than the number.
 310     ...Unless the user has coded bracket-visibility = #t, that is.
 311   */
 312   Real gap = 0.;
 313   if (bracket_visibility && number_grob)
 314     {
 315       Interval ext = number_grob->extent (number_grob, X_AXIS);
 316       if (!ext.is_empty ())
 317         {
 318           gap = ext.length () + 1.0;
 319
 320           if ((0.75 * x_span.length () < gap) && !bracket_prop)
 321             bracket_visibility = false;
 322         }
 323     }
 324
 325   if (bracket_visibility)
 326     {
 327       Drul_array<Real> zero (0, 0);
 328       Real ss = Staff_symbol_referencer::staff_space (me);
 329       Drul_array<Real> height
 330         = robust_scm2drul (me->get_property ("edge-height"), zero);
 331       Drul_array<Real> flare
 332         = robust_scm2drul (me->get_property ("bracket-flare"), zero);
 333       Drul_array<Real> shorten
 334         = robust_scm2drul (me->get_property ("shorten-pair"), zero);
 335       Drul_array<Stencil> edge_stencils;
 336
 337       Direction dir = get_grob_direction (me);
 338
 339       scale_drul (&height, -ss * dir);
 340       scale_drul (&flare, ss);
 341       scale_drul (&shorten, ss);
 342
 343       Drul_array<bool> connect_to_other
 344         = robust_scm2booldrul (me->get_property ("connect-to-neighbor"),
 345                                Drul_array<bool> (false, false));
 346
 347       for (LEFT_and_RIGHT (d))
 348         {
 349           if (connect_to_other[d])
 350             {
 351               height[d] = 0.0;
 352               flare[d] = 0.0;
 353               shorten[d] = 0.0;
 354
 355               SCM edge_text = me->get_property ("edge-text");
 356
 357               if (scm_is_pair (edge_text))
 358                 {
 359                   SCM properties = Font_interface::text_font_alist_chain (me);
 360                   SCM text = index_get_cell (edge_text, d);
 361                   if (Text_interface::is_markup (text))
 362                     {
 363                       SCM t
 364                         = Text_interface::interpret_markup (pap->self_scm (),
 365                                                             properties, text);
 366
 367                       Stencil *edge_text = unsmob<Stencil> (t);
 368                       edge_text->translate_axis (x_span[d] - x_span[LEFT],
 369                                                  X_AXIS);
 370                       edge_stencils[d] = *edge_text;
 371                     }
 372                 }
 373             }
 374         }
 375
 376       Stencil brack = make_bracket (me, Y_AXIS,
 377                                     points[RIGHT] - points[LEFT],
 378                                     height,
 379                                     /*
 380                                       0.1 = more space at right due to italics
 381                                       TODO: use italic correction of font.
 382                                     */
 383                                     Interval (-0.5, 0.5) * gap + 0.1,
 384                                     flare, shorten);
 385
 386       for (LEFT_and_RIGHT (d))
 387         {
 388           if (!edge_stencils[d].is_empty ())
 389             brack.add_stencil (edge_stencils[d]);
 390         }
 391
 392       mol.add_stencil (brack);
 393     }
 394
 395   mol.translate (points[LEFT]);
 396   return mol.smobbed_copy ();
 397 }
 398
 399 /*
 400   should move to lookup?
 401
 402   TODO: this will fail for very short (shorter than the flare)
 403   brackets.
 404 */
 405 Stencil
 406 Tuplet_bracket::make_bracket (Grob *me, // for line properties.
 407                               Axis protrusion_axis,
 408                               Offset dz,
 409                               Drul_array<Real> height,
 410                               Interval gap,
 411                               Drul_array<Real> flare,
 412                               Drul_array<Real> shorten)
 413 {
 414   Drul_array<Offset> corners (Offset (0, 0), dz);
 415
 416   Real length = dz.length ();
 417   Drul_array<Offset> gap_corners;
 418
 419   Axis bracket_axis = other_axis (protrusion_axis);
 420
 421   Drul_array<Offset> straight_corners = corners;
 422
 423   for (LEFT_and_RIGHT (d))
 424     straight_corners[d] += -d * shorten[d] / length * dz;
 425
 426   if (!gap.is_empty ())
 427     {
 428       for (LEFT_and_RIGHT (d))
 429         gap_corners[d] = (dz * 0.5) + gap[d] / length * dz;
 430     }
 431
 432   Drul_array<Offset> flare_corners = straight_corners;
 433   for (LEFT_and_RIGHT (d))
 434     {
 435       flare_corners[d][bracket_axis] = straight_corners[d][bracket_axis];
 436       flare_corners[d][protrusion_axis] += height[d];
 437       straight_corners[d][bracket_axis] += -d * flare[d];
 438     }
 439
 440   Stencil m;
 441   if (!gap.is_empty ())
 442     for (LEFT_and_RIGHT (d))
 443       m.add_stencil (Line_interface::line (me, straight_corners[d],
 444                                            gap_corners[d]));
 445   else
 446     m.add_stencil (Line_interface::line (me, straight_corners[LEFT],
 447                                          straight_corners[RIGHT]));
 448
 449   if (scm_is_number (me->get_property ("dash-fraction")))
 450     me->set_property ("dash-fraction", scm_from_double (1.0));
 451   for (LEFT_and_RIGHT (d))
 452     m.add_stencil (Line_interface::line (me, straight_corners[d],
 453                                          flare_corners[d]));
 454   return m;
 455 }
 456
 457 void
 458 Tuplet_bracket::get_bounds (Grob *me, Grob **left, Grob **right)
 459 {
 460   extract_grob_set (me, "note-columns", columns);
 461   vsize l = 0;
 462   while (l < columns.size () && Note_column::has_rests (columns[l]))
 463     l++;
 464
 465   vsize r = columns.size ();
 466   while (r > l && Note_column::has_rests (columns[r - 1]))
 467     r--;
 468
 469   *left = *right = 0;
 470
 471   if (l < r)
 472     {
 473       *left = columns[l];
 474       *right = columns[r - 1];
 475     }
 476 }
 477
 478 /*
 479   use first -> last note for slope, and then correct for disturbing
 480   notes in between.  */
 481 void
 482 Tuplet_bracket::calc_position_and_height (Grob *me_grob, Real *offset, Real *dy)
 483 {
 484   Spanner *me = dynamic_cast<Spanner *> (me_grob);
 485
 486   extract_grob_set (me, "note-columns", columns);
 487   extract_grob_set (me, "tuplets", tuplets);
 488
 489   Grob *commony = common_refpoint_of_array (columns, me, Y_AXIS);
 490   commony = common_refpoint_of_array (tuplets, commony, Y_AXIS);
 491   if (Grob *st = Staff_symbol_referencer::get_staff_symbol (me))
 492     commony = st->common_refpoint (commony, Y_AXIS);
 493   Real my_offset = me->relative_coordinate (commony, Y_AXIS);
 494
 495   Grob *commonx = get_common_x (me);
 496   commonx = common_refpoint_of_array (tuplets, commonx, Y_AXIS);
 497
 498   Interval staff;
 499   Grob *st = Staff_symbol_referencer::get_staff_symbol (me);
 500
 501   /* staff-padding doesn't work correctly on cross-staff tuplets
 502      because it only considers one staff symbol. Until this works,
 503      disable it. */
 504   if (st && !to_boolean (me->get_property ("cross-staff")))
 505     {
 506       Real pad = robust_scm2double (me->get_property ("staff-padding"), -1.0);
 507       if (pad >= 0.0)
 508         {
 509           staff = st->extent (commony, Y_AXIS) - my_offset;
 510           staff.widen (pad);
 511         }
 512     }
 513
 514   Direction dir = get_grob_direction (me);
 515
 516   bool equally_long = false;
 517   Grob *par_beam = parallel_beam (me, columns, &equally_long);
 518
 519   Item *lgr = get_x_bound_item (me, LEFT, dir);
 520   Item *rgr = get_x_bound_item (me, RIGHT, dir);
 521   Real x0 = robust_relative_extent (lgr, commonx, X_AXIS)[LEFT];
 522   Real x1 = robust_relative_extent (rgr, commonx, X_AXIS)[RIGHT];
 523   bool follow_beam = par_beam
 524                      && get_grob_direction (par_beam) == dir
 525                      && !Beam::is_knee (par_beam);
 526
 527   vector<Offset> points;
 528   if (columns.size ()
 529       && follow_beam
 530       && Note_column::get_stem (columns[0])
 531       && Note_column::get_stem (columns.back ()))
 532     {
 533       Drul_array<Grob *> stems (Note_column::get_stem (columns[0]),
 534                                 Note_column::get_stem (columns.back ()));
 535
 536       Interval poss;
 537       for (LEFT_and_RIGHT (side))
 538         {
 539           // Trigger setting of stem lengths if necessary.
 540           if (Grob *beam = Stem::get_beam (stems[side]))
 541             (void) beam->get_property ("quantized-positions");
 542           poss[side] = stems[side]->extent (stems[side], Y_AXIS)[get_grob_direction (stems[side])]
 543                        + stems[side]->get_parent (Y_AXIS)->relative_coordinate (commony, Y_AXIS);
 544         }
 545
 546       *dy = poss[RIGHT] - poss[LEFT];
 547       points.push_back (Offset (stems[LEFT]->relative_coordinate (commonx, X_AXIS) - x0, poss[LEFT]));
 548       points.push_back (Offset (stems[RIGHT]->relative_coordinate (commonx, X_AXIS) - x0, poss[RIGHT]));
 549     }
 550   else
 551     {
 552       /*
 553         Use outer non-rest columns to determine slope
 554       */
 555       Grob *left_col = 0;
 556       Grob *right_col = 0;
 557       get_bounds (me, &left_col, &right_col);
 558       if (left_col && right_col)
 559         {
 560           Interval rv = Note_column::cross_staff_extent (right_col, commony);
 561           Interval lv = Note_column::cross_staff_extent (left_col, commony);
 562           rv.unite (staff);
 563           lv.unite (staff);
 564
 565           Real graphical_dy = rv[dir] - lv[dir];
 566
 567           Slice ls = Note_column::head_positions_interval (left_col);
 568           Slice rs = Note_column::head_positions_interval (right_col);
 569
 570           Interval musical_dy;
 571           musical_dy[UP] = rs[UP] - ls[UP];
 572           musical_dy[DOWN] = rs[DOWN] - ls[DOWN];
 573           if (sign (musical_dy[UP]) != sign (musical_dy[DOWN]))
 574             *dy = 0.0;
 575           else if (sign (graphical_dy) != sign (musical_dy[DOWN]))
 576             *dy = 0.0;
 577           else
 578             *dy = graphical_dy;
 579         }
 580       else
 581         *dy = 0;
 582
 583       for (vsize i = 0; i < columns.size (); i++)
 584         {
 585           Interval note_ext = Note_column::cross_staff_extent (columns[i],
 586                                                                commony);
 587           Real x = columns[i]->relative_coordinate (commonx, X_AXIS) - x0;
 588
 589           points.push_back (Offset (x, note_ext[dir]));
 590         }
 591     }
 592
 593   if (!follow_beam)
 594     {
 595       points.push_back (Offset (x0 - x0, staff[dir]));
 596       points.push_back (Offset (x1 - x0, staff[dir]));
 597     }
 598
 599   /*
 600     This is a slight hack. We compute two encompass points from the
 601     bbox of the smaller tuplets.
 602
 603     We assume that the smaller bracket is 1.0 space high.
 604   */
 605   Real ss = Staff_symbol_referencer::staff_space (me);
 606   for (vsize i = 0; i < tuplets.size (); i++)
 607     {
 608       Interval tuplet_x (tuplets[i]->extent (commonx, X_AXIS));
 609       Interval tuplet_y (tuplets[i]->extent (commony, Y_AXIS));
 610
 611       if (!tuplets[i]->is_live ())
 612         continue;
 613
 614       Drul_array<Real> positions
 615         = robust_scm2interval (tuplets[i]->get_property ("positions"),
 616                                Interval (0, 0));
 617
 618       Real other_dy = positions[RIGHT] - positions[LEFT];
 619
 620       for (LEFT_and_RIGHT (d))
 621         {
 622           Real y
 623             = tuplet_y.linear_combination (d * sign (other_dy));
 624
 625           /*
 626             We don't take padding into account for nested tuplets.
 627             the edges can come very close to the stems, likewise for
 628             nested tuplets?
 629           */
 630
 631           points.push_back (Offset (tuplet_x[d] - x0, y));
 632         }
 633
 634       // Check for number-on-bracket collisions
 635       Grob *number = unsmob<Grob> (tuplets[i]->get_object ("tuplet-number"));
 636       if (number)
 637         {
 638           Interval x_ext = robust_relative_extent (number, commonx, X_AXIS);
 639           Interval y_ext = robust_relative_extent (number, commony, Y_AXIS);
 640           points.push_back (Offset (x_ext.center () - x0, y_ext[dir]));
 641         }
 642     }
 643
 644   if (to_boolean (me->get_property ("avoid-scripts"))
 645       && !scm_is_number (me->get_property ("outside-staff-priority")))
 646     {
 647       extract_grob_set (me, "scripts", scripts);
 648       for (vsize i = 0; i < scripts.size (); i++)
 649         {
 650           if (!scripts[i]->is_live ())
 651             continue;
 652           if (scm_is_number (scripts[i]->get_property ("outside-staff-priority")))
 653             continue;
 654
 655           // assume that if a script is avoiding slurs, it should not get placed
 656           // under a tuplet bracket
 657           if (unsmob<Grob> (scripts[i]->get_object ("slur")))
 658             continue;
 659
 660           Interval script_x
 661             = robust_relative_extent (scripts[i], commonx, X_AXIS);
 662           Interval script_y
 663             = robust_relative_extent (scripts[i], commony, Y_AXIS);
 664
 665           points.push_back (Offset (script_x.center () - x0,
 666                                     script_y[dir]));
 667         }
 668     }
 669
 670   *offset = -dir * infinity_f;
 671   Real factor = (columns.size () > 1) ? 1 / (x1 - x0) : 1.0;
 672   for (vsize i = 0; i < points.size (); i++)
 673     {
 674       Real x = points[i][X_AXIS];
 675       Real tuplety = (*dy) * x * factor + my_offset;
 676
 677       if (points[i][Y_AXIS] * dir > (*offset + tuplety) * dir)
 678         *offset = points[i][Y_AXIS] - tuplety;
 679     }
 680
 681   *offset += scm_to_double (me->get_property ("padding")) * dir;
 682
 683   /*
 684     horizontal brackets should not collide with staff lines.
 685
 686     This doesn't seem to support cross-staff tuplets atm.
 687   */
 688   if (*dy == 0)
 689     {
 690       // quantize, then do collision check.
 691       *offset /= 0.5 * ss;
 692
 693       Interval staff_span = Staff_symbol_referencer::staff_span (me);
 694       if (staff_span.contains (*offset))
 695         {
 696           *offset = rint (*offset);
 697           if (Staff_symbol_referencer::on_line (me, int (*offset)))
 698             *offset += dir;
 699         }
 700
 701       *offset *= 0.5 * ss;
 702     }
 703 }
 704
 705 MAKE_SCHEME_CALLBACK (Tuplet_bracket, calc_direction, 1);
 706 SCM
 707 Tuplet_bracket::calc_direction (SCM smob)
 708 {
 709   Grob *me = unsmob<Grob> (smob);
 710   Direction dir = Tuplet_bracket::get_default_dir (me);
 711   return scm_from_int (dir);
 712 }
 713
 714 MAKE_SCHEME_CALLBACK (Tuplet_bracket, calc_positions, 1);
 715 SCM
 716 Tuplet_bracket::calc_positions (SCM smob)
 717 {
 718   Spanner *me = unsmob<Spanner> (smob);
 719
 720   Real dy = 0.0;
 721   Real offset = 0.0;
 722   calc_position_and_height (me, &offset, &dy);
 723
 724   SCM x = scm_cons (scm_from_double (offset),
 725                     scm_from_double (offset + dy));
 726
 727   return x;
 728 }
 729
 730 /*
 731   similar to beam ?
 732 */
 733 Direction
 734 Tuplet_bracket::get_default_dir (Grob *me)
 735 {
 736   Drul_array<int> dirs (0, 0);
 737   extract_grob_set (me, "note-columns", columns);
 738   for (vsize i = 0; i < columns.size (); i++)
 739     {
 740       Grob *nc = columns[i];
 741       if (Note_column::has_rests (nc))
 742         continue;
 743       Direction d = Note_column::dir (nc);
 744       if (d)
 745         dirs[d]++;
 746     }
 747
 748   if (dirs[UP] == dirs[DOWN])
 749     {
 750       if (dirs[UP] == 0)
 751         return UP;
 752       Grob *staff = Staff_symbol_referencer::get_staff_symbol (me);
 753       if (!staff)
 754         return UP;
 755       Interval staff_extent = staff->extent (staff, Y_AXIS);
 756       Interval extremal_positions;
 757       extremal_positions.set_empty ();
 758       for (vsize i = 0; i < columns.size (); i++)
 759         {
 760           Direction d = Note_column::dir (columns[i]);
 761           extremal_positions[d] = minmax (d, 1.0 * Note_column::head_positions_interval (columns[i])[d], extremal_positions[d]);
 762         }
 763       for (LEFT_and_RIGHT (d))
 764         extremal_positions[d] = -d * (staff_extent[d] - extremal_positions[d]);
 765
 766       return extremal_positions[UP] <= extremal_positions[DOWN] ? UP : DOWN;
 767     }
 768
 769   return dirs[UP] > dirs[DOWN] ? UP : DOWN;
 770 }
 771
 772 void
 773 Tuplet_bracket::add_column (Grob *me, Item *n)
 774 {
 775   Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-columns"), n);
 776   add_bound_item (dynamic_cast<Spanner *> (me), n);
 777 }
 778
 779 void
 780 Tuplet_bracket::add_script (Grob *me, Item *s)
 781 {
 782   Pointer_group_interface::add_grob (me, ly_symbol2scm ("scripts"), s);
 783 }
 784
 785 void
 786 Tuplet_bracket::add_tuplet_bracket (Grob *me, Grob *bracket)
 787 {
 788   Pointer_group_interface::add_grob (me, ly_symbol2scm ("tuplets"), bracket);
 789 }
 790
 791 MAKE_SCHEME_CALLBACK (Tuplet_bracket, calc_cross_staff, 1);
 792 SCM
 793 Tuplet_bracket::calc_cross_staff (SCM smob)
 794 {
 795   Grob *me = unsmob<Grob> (smob);
 796   extract_grob_set (me, "note-columns", cols);
 797   extract_grob_set (me, "tuplets", tuplets);
 798
 799   Grob *commony = common_refpoint_of_array (cols, me, Y_AXIS);
 800   commony = common_refpoint_of_array (tuplets, commony, Y_AXIS);
 801   if (Grob *st = Staff_symbol_referencer::get_staff_symbol (me))
 802     commony = st->common_refpoint (commony, Y_AXIS);
 803   if (me->check_cross_staff (commony))
 804     return SCM_BOOL_T;
 805
 806   bool equally_long = false;
 807   Grob *par_beam = parallel_beam (me, cols, &equally_long);
 808
 809   if (par_beam && to_boolean (par_beam->get_property ("cross-staff")))
 810     return SCM_BOOL_T;
 811
 812   for (vsize i = 0; i < cols.size (); i++)
 813     {
 814       Grob *stem = unsmob<Grob> (cols[i]->get_object ("stem"));
 815       if (stem && to_boolean (stem->get_property ("cross-staff")))
 816         return SCM_BOOL_T;
 817     }
 818
 819   return SCM_BOOL_F;
 820 }
 821
 822 ADD_INTERFACE (Tuplet_bracket,
 823                "A bracket with a number in the middle, used for tuplets."
 824                "  When the bracket spans a line break, the value of"
 825                " @code{break-overshoot} determines how far it extends"
 826                " beyond the staff.  At a line break, the markups in the"
 827                " @code{edge-text} are printed at the edges.",
 828
 829                /* properties */
 830                "avoid-scripts "
 831                "bracket-flare "
 832                "bracket-visibility "
 833                "break-overshoot "
 834                "connect-to-neighbor "
 835                "direction "
 836                "edge-height "
 837                "edge-text "
 838                "full-length-padding "
 839                "full-length-to-extent "
 840                "gap "
 841                "positions "
 842                "note-columns "
 843                "padding "
 844                "tuplet-number "
 845                "scripts "
 846                "shorten-pair "
 847                "staff-padding "
 848                "thickness "
 849                "tuplets "
 850                "X-positions "
 851               );