lily/tuplet-bracket.cc

   1 /*
   2   tuplet-bracket.cc -- implement Tuplet_bracket
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2004 Jan Nieuwenhuizen <janneke@gnu.org>
   7   Han-Wen Nienhuys <hanwen@xs4all.nl>
   8 */
   9
  10 /*
  11   TODO:
  12
  13   - tuplet bracket should probably be subject to the same rules as
  14   beam sloping/quanting.
  15
  16   - There is no support for kneed brackets, or nested brackets.
  17
  18   - number placement for parallel beams should be much more advanced:
  19     for sloped beams some extra horizontal offset must be introduced.
  20
  21   - number placement is usually done over the center note, not the
  22     graphical center.
  23
  24  */
  25
  26 /*
  27
  28     TODO: quantise, we don't want to collide with staff lines.
  29  (or should we be above staff?)
  30
  31   todo: handle breaking elegantly.
  32 */
  33
  34 #include <math.h>
  35
  36 #include "tuplet-bracket.hh"
  37 #include "line-interface.hh"
  38 #include "beam.hh"
  39 #include "warn.hh"
  40 #include "font-interface.hh"
  41 #include "output-def.hh"
  42 #include "text-item.hh"
  43 #include "stem.hh"
  44 #include "note-column.hh"
  45 #include "group-interface.hh"
  46 #include "directional-element-interface.hh"
  47 #include "spanner.hh"
  48 #include "staff-symbol-referencer.hh"
  49 #include "lookup.hh"
  50
  51 static Grob*
  52 get_x_bound_grob (Grob *g, Direction my_dir)
  53 {
  54   if (Note_column::get_stem (g)
  55       && Note_column::dir (g) == my_dir)
  56     {
  57       g = Note_column::get_stem (g);
  58     }
  59   return g;
  60 }
  61
  62
  63
  64 Grob*
  65 Tuplet_bracket::parallel_beam (Grob *me, Link_array<Grob> const &cols, bool *equally_long)
  66 {
  67   /*
  68     ugh: code dup.
  69   */
  70   Grob *s1 = Note_column::get_stem (cols[0]);
  71   Grob *s2 = Note_column::get_stem (cols.top ());
  72
  73   Grob*b1 = s1 ? Stem::get_beam (s1) : 0;
  74   Grob*b2 = s2 ? Stem::get_beam (s2) : 0;
  75
  76   Spanner*sp = dynamic_cast<Spanner*> (me);
  77
  78   *equally_long = false;
  79   if (! (b1 && (b1 == b2) && !sp->is_broken ()))
  80       return 0;
  81
  82   Link_array<Grob> beam_stems = Pointer_group_interface__extract_grobs
  83     (b1, (Grob*)0, "stems");
  84
  85   if (beam_stems.size () == 0)
  86     {
  87       programming_error ("Beam under tuplet bracket has no stems!");
  88       *equally_long = 0;
  89       return 0;
  90     }
  91
  92   *equally_long = (beam_stems[0] == s1 && beam_stems.top () == s2);
  93   return b1;
  94 }
  95
  96
  97 /*
  98   TODO:
  99
 100   in the case that there is no bracket, but there is a (single) beam,
 101   follow beam precisely for determining tuplet number location.
 102
 103  */
 104 MAKE_SCHEME_CALLBACK (Tuplet_bracket,print,1);
 105 SCM
 106 Tuplet_bracket::print (SCM smob)
 107 {
 108   Grob *me = unsmob_grob (smob);
 109   Stencil  mol;
 110   Link_array<Grob> columns =
 111     Pointer_group_interface__extract_grobs (me, (Grob*)0, "note-columns");
 112
 113   if (!columns.size ())
 114     return mol.smobbed_copy ();
 115
 116
 117
 118   {
 119     SCM lp = me->get_property ("left-position");
 120     SCM rp = me->get_property ("right-position");
 121
 122     if (!scm_is_number (rp) || !scm_is_number (lp))
 123       after_line_breaking (smob);
 124   }
 125
 126   Real ly = robust_scm2double (me->get_property ("left-position"), 0);
 127   Real ry = robust_scm2double (me->get_property ("right-position"), 0);
 128
 129   bool equally_long = false;
 130   Grob * par_beam = parallel_beam (me, columns, &equally_long);
 131
 132   Spanner*sp = dynamic_cast<Spanner*> (me);
 133
 134   bool bracket_visibility = !(par_beam && equally_long);
 135   bool number_visibility = true;
 136
 137   /*
 138     Fixme: the type of this prop is sucky.
 139    */
 140   SCM bracket = me->get_property ("bracket-visibility");
 141   if (scm_is_bool (bracket))
 142     {
 143       bracket_visibility = ly_scm2bool (bracket);
 144     }
 145   else if (bracket == ly_symbol2scm ("if-no-beam"))
 146     bracket_visibility = !par_beam;
 147
 148   SCM numb = me->get_property ("number-visibility");
 149   if (scm_is_bool (numb))
 150     {
 151       number_visibility = ly_scm2bool (numb);
 152     }
 153   else if (numb == ly_symbol2scm ("if-no-beam"))
 154     number_visibility = !par_beam;
 155
 156   Grob * commonx = columns[0]->common_refpoint (columns.top (),X_AXIS);
 157
 158   /*
 159     Tuplet brackets are normally not broken, but we shouldn't crash if
 160     they are.
 161    */
 162   commonx = commonx->common_refpoint (sp->get_bound (LEFT), X_AXIS);
 163   commonx = commonx->common_refpoint (sp->get_bound (RIGHT), X_AXIS);
 164
 165   Direction dir = get_grob_direction (me);
 166
 167   Grob * lgr = get_x_bound_grob (columns[0], dir);
 168   Grob * rgr = get_x_bound_grob (columns.top (), dir);
 169
 170   Real x0 = robust_relative_extent (lgr, commonx, X_AXIS)[LEFT];
 171   Real x1 = robust_relative_extent (rgr, commonx, X_AXIS)[RIGHT];
 172   Real w = x1 -x0;
 173
 174   SCM number = me->get_property ("text");
 175
 176   Output_def *pap = me->get_layout ();
 177   Stencil num;
 178  if (scm_is_string (number) && number_visibility)
 179     {
 180       SCM properties = Font_interface::text_font_alist_chain (me);
 181       SCM snum = Text_interface::interpret_markup (pap->self_scm (), properties, number);
 182       num = *unsmob_stencil (snum);
 183       num.align_to (X_AXIS, CENTER);
 184       num.translate_axis (w/2, X_AXIS);
 185       num.align_to (Y_AXIS, CENTER);
 186
 187       num.translate_axis ((ry-ly)/2, Y_AXIS);
 188
 189       mol.add_stencil (num);
 190     }
 191
 192
 193   /*
 194     No bracket when it would be smaller than the number.
 195
 196     TODO: should use GAP in calculation too.
 197    */
 198   if (bracket_visibility && number_visibility
 199       && mol.extent (X_AXIS).length () > w)
 200     {
 201       bracket_visibility = false;
 202     }
 203
 204   if (bracket_visibility)
 205     {
 206       Real ss =   Staff_symbol_referencer::staff_space (me);
 207       Real gap = 0.;
 208
 209       if (!num.extent (X_AXIS).is_empty ())
 210         gap = num.extent (X_AXIS).length () + 1.0;
 211
 212       SCM fl = me->get_property ("bracket-flare");
 213       SCM eh = me->get_property ("edge-height");
 214       SCM sp = me->get_property ("shorten-pair");
 215
 216       Direction d = LEFT;
 217       Drul_array<Real> height, flare, shorten;
 218       do {
 219         flare[d] =  height[d] = shorten[d] = 0.0;
 220         if (is_number_pair (fl))
 221           flare[d] +=  ss * scm_to_double (index_get_cell (fl, d));
 222         if (is_number_pair (eh))
 223           height[d] +=  - dir * ss *scm_to_double (index_get_cell (eh, d));
 224         if (is_number_pair (sp))
 225           shorten[d] +=  ss *scm_to_double (index_get_cell (sp, d));
 226       }
 227       while (flip (&d) != LEFT);
 228
 229       Stencil brack = make_bracket (me, Y_AXIS,
 230                                      Offset (w, ry - ly),
 231                                      height,
 232                                     /*
 233                                       0.1 = more space at right due to italics
 234                                       TODO: use italic correction of font.
 235                                      */
 236                                     Interval (-0.5, 0.5) * gap + 0.1,
 237                                      flare, shorten);
 238       mol.add_stencil (brack);
 239     }
 240
 241   mol.translate_axis (ly, Y_AXIS);
 242   mol.translate_axis (x0  - sp->get_bound (LEFT)->relative_coordinate (commonx,X_AXIS),X_AXIS);
 243   return mol.smobbed_copy ();
 244 }
 245
 246 /*
 247   should move to lookup?
 248
 249   TODO: this will fail for very short (shorter than the flare)
 250   brackets.
 251  */
 252 Stencil
 253 Tuplet_bracket::make_bracket (Grob *me, // for line properties.
 254                               Axis protusion_axis,
 255                               Offset dz,
 256                               Drul_array<Real> height,
 257                               Interval gap,
 258                               Drul_array<Real> flare,
 259                               Drul_array<Real> shorten)
 260 {
 261   Drul_array<Offset> corners (Offset (0,0), dz);
 262
 263   Real length = dz.length ();
 264   Drul_array<Offset> gap_corners;
 265
 266
 267   Axis bracket_axis = other_axis (protusion_axis);
 268
 269   Drul_array<Offset> straight_corners = corners;
 270
 271   Direction d = LEFT;
 272   do {
 273     straight_corners[d] += - d * shorten[d] /length * dz;
 274   } while (flip (&d) != LEFT);
 275
 276
 277   if (gap.is_empty())
 278     gap = Interval (0,0);
 279   do {
 280     gap_corners[d] = (dz * 0.5) + gap[d] / length * dz;
 281   } while (flip (&d) != LEFT);
 282
 283   Drul_array<Offset> flare_corners = straight_corners;
 284   do {
 285     flare_corners[d][bracket_axis] = straight_corners[d][bracket_axis];
 286     flare_corners[d][protusion_axis] += height[d];
 287     straight_corners[d][bracket_axis] += - d * flare[d];
 288   } while (flip (&d) != LEFT);
 289
 290   Stencil m;
 291   do {
 292     m.add_stencil (Line_interface::line (me, straight_corners[d],
 293                                          gap_corners[d]));
 294
 295     m.add_stencil (Line_interface::line (me,  straight_corners[d],
 296                                          flare_corners[d]));
 297   } while (flip (&d) != LEFT);
 298
 299   return m;
 300 }
 301
 302
 303 /*
 304   use first -> last note for slope, and then correct for disturbing
 305   notes in between.  */
 306 void
 307 Tuplet_bracket::calc_position_and_height (Grob*me, Real *offset, Real * dy)
 308 {
 309   Link_array<Grob> columns =
 310     Pointer_group_interface__extract_grobs (me, (Grob*)0, "note-columns");
 311
 312   SCM cols = me->get_property ("note-columns");
 313   Grob * commony = common_refpoint_of_list (cols, me, Y_AXIS);
 314   Grob * commonx = common_refpoint_of_list (cols, me, X_AXIS);
 315
 316   Interval staff;
 317   if (Grob * st = Staff_symbol_referencer::get_staff_symbol (me))
 318     staff = st->extent (commony, Y_AXIS);
 319
 320   Direction dir = get_grob_direction (me);
 321
 322   /*
 323     Use outer non-rest columns to determine slope
 324    */
 325   int l = 0;
 326   while (l <columns.size () && Note_column::has_rests (columns[l]))
 327     l ++;
 328
 329   int r = columns.size ()- 1;
 330   while (r >= l && Note_column::has_rests (columns[r]))
 331     r--;
 332
 333   if (l < r)
 334     {
 335       Interval rv = columns[r]->extent (commony, Y_AXIS);
 336       Interval lv = columns[l]->extent (commony, Y_AXIS);
 337       rv.unite (staff);
 338       lv.unite (staff);
 339       Real graphical_dy =  rv[dir] - lv[dir];
 340
 341       Slice ls = Note_column::head_positions_interval (columns[l]);
 342       Slice rs = Note_column::head_positions_interval (columns[r]);
 343
 344       Interval musical_dy;
 345       musical_dy[UP] = rs[UP] - ls[UP];
 346       musical_dy[DOWN] = rs[DOWN] - ls[DOWN];
 347       if (sign (musical_dy[UP]) != sign (musical_dy[DOWN]))
 348         *dy = 0.0;
 349       else if (sign (graphical_dy) != sign (musical_dy[DOWN]))
 350         *dy = 0.0;
 351       else
 352         *dy = graphical_dy;
 353     }
 354   else
 355     * dy = 0;
 356
 357
 358   *offset = - dir * infinity_f;
 359
 360   if (!columns.size ())
 361     return;
 362
 363
 364
 365   Grob * lgr = get_x_bound_grob (columns[0], dir);
 366   Grob * rgr = get_x_bound_grob (columns.top (), dir);
 367   Real x0 = robust_relative_extent (lgr, commonx, X_AXIS)[LEFT];
 368   Real x1 = robust_relative_extent (rgr, commonx, X_AXIS)[RIGHT];
 369
 370   /*
 371     Slope.
 372   */
 373   Real factor = columns.size () > 1 ? 1/ (x1 - x0) : 1.0;
 374
 375   for (int i = 0; i < columns.size ();  i++)
 376     {
 377       Interval note_ext = columns[i]->extent (commony, Y_AXIS);
 378       note_ext.unite (staff);
 379       Real notey = note_ext[dir] - me->relative_coordinate (commony, Y_AXIS);
 380
 381       Real x = columns[i]->relative_coordinate (commonx, X_AXIS) - x0;
 382       Real tuplety =  *dy * x * factor;
 383
 384       if (notey * dir > (*offset + tuplety) * dir)
 385         *offset = notey - tuplety;
 386     }
 387
 388   // padding
 389   *offset +=  scm_to_double (me->get_property ("padding")) *dir;
 390
 391
 392   /*
 393     horizontal brackets should not collide with staff lines.
 394
 395    */
 396   Real ss = Staff_symbol_referencer::staff_space (me);
 397   if (*dy == 0 && fabs (*offset) <  ss * Staff_symbol_referencer::staff_radius (me))
 398     {
 399       // quantize, then do collision check.
 400       *offset *= 2 / ss;
 401
 402       *offset = rint (*offset);
 403       if (Staff_symbol_referencer::on_staffline (me, (int) rint (*offset)))
 404         *offset += dir;
 405
 406       *offset *= 0.5 * ss;
 407     }
 408
 409 }
 410
 411
 412
 413 /*
 414   We depend on the beams if there are any.
 415  */
 416 MAKE_SCHEME_CALLBACK (Tuplet_bracket,before_line_breaking,1);
 417 SCM
 418 Tuplet_bracket::before_line_breaking (SCM smob)
 419 {
 420   Grob *me = unsmob_grob (smob);
 421   Link_array<Grob> columns =
 422     Pointer_group_interface__extract_grobs (me, (Grob*)0, "note-columns");
 423
 424
 425   for (int i = columns.size (); i--;)
 426     {
 427       Grob * s = Note_column::get_stem (columns[i]);
 428       Grob * b = s ? Stem::get_beam (s): 0;
 429       if (b)
 430         me->add_dependency (b);
 431     }
 432   return SCM_UNSPECIFIED;
 433 }
 434
 435 MAKE_SCHEME_CALLBACK (Tuplet_bracket,after_line_breaking,1);
 436
 437 SCM
 438 Tuplet_bracket::after_line_breaking (SCM smob)
 439 {
 440   Grob * me = unsmob_grob (smob);
 441   Link_array<Grob> columns =
 442     Pointer_group_interface__extract_grobs (me, (Grob*)0, "note-columns");
 443
 444   if (!columns.size ())
 445     {
 446       me->suicide ();
 447       return SCM_UNSPECIFIED;
 448     }
 449   if (dynamic_cast<Spanner*> (me)->is_broken ())
 450     {
 451       me->warning (_("Killing tuplet bracket across linebreak."));
 452       me->suicide ();
 453       return SCM_UNSPECIFIED;
 454     }
 455
 456   Direction dir = get_grob_direction (me);
 457   if (!dir)
 458     {
 459       dir = Tuplet_bracket::get_default_dir (me);
 460       set_grob_direction (me, dir);
 461     }
 462
 463   bool equally_long = false;
 464   Grob * par_beam = parallel_beam (me, columns, &equally_long);
 465
 466   /*
 467     We follow the beam only if there is one, and we are next to it.
 468    */
 469   Real dy, offset;
 470   if (!par_beam
 471       || get_grob_direction (par_beam) != dir)
 472     {
 473       calc_position_and_height (me,&offset,&dy);
 474     }
 475   else
 476     {
 477       SCM ps =  par_beam->get_property ("positions");
 478
 479       Real lp = scm_to_double (scm_car (ps));
 480       Real rp = scm_to_double (scm_cdr (ps));
 481
 482       /*
 483         duh. magic.
 484        */
 485       offset = lp + dir * (0.5 + scm_to_double (me->get_property ("padding")));
 486       dy = rp- lp;
 487     }
 488
 489
 490   SCM lp =  me->get_property ("left-position");
 491   SCM rp = me->get_property ("right-position");
 492
 493   if (scm_is_number (lp) && !scm_is_number (rp))
 494     {
 495       rp = scm_make_real (scm_to_double (lp) + dy);
 496     }
 497   else if (scm_is_number (rp) && !scm_is_number (lp))
 498     {
 499       lp = scm_make_real (scm_to_double (rp) - dy);
 500     }
 501   else if (!scm_is_number (rp) && !scm_is_number (lp))
 502     {
 503       lp = scm_make_real (offset);
 504       rp = scm_make_real (offset + dy);
 505     }
 506
 507   me->set_property ("left-position", lp);
 508   me->set_property ("right-position", rp);
 509
 510   return SCM_UNSPECIFIED;
 511 }
 512
 513
 514 /*
 515   similar to beam ?
 516  */
 517 Direction
 518 Tuplet_bracket::get_default_dir (Grob*me)
 519 {
 520   Drul_array<int> dirs (0,0);
 521   for (SCM s = me->get_property ("note-columns"); scm_is_pair (s); s = scm_cdr (s))
 522     {
 523       Grob * nc = unsmob_grob (scm_car (s));
 524       Direction d = Note_column::dir (nc);
 525       if (d)
 526         dirs[d]++;
 527     }
 528
 529   return dirs[UP] >= dirs[DOWN] ? UP : DOWN;
 530 }
 531
 532 void
 533 Tuplet_bracket::add_column (Grob*me, Item*n)
 534 {
 535   Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-columns"), n);
 536   me->add_dependency (n);
 537
 538   add_bound_item (dynamic_cast<Spanner*> (me), n);
 539 }
 540
 541
 542
 543
 544
 545
 546 ADD_INTERFACE (Tuplet_bracket,
 547                "tuplet-bracket-interface",
 548                "A bracket with a number in the middle, used for tuplets.",
 549
 550                "note-columns bracket-flare edge-height shorten-pair "
 551                "padding left-position right-position bracket-visibility "
 552                "number-visibility thickness direction");
 553