lily/tuplet-bracket.cc

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