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