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