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