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