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