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