lily/tie.cc

   1 /*
   2   tie.cc -- implement Tie
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 #include "tie.hh"
  10
  11 #include <math.h>
  12
  13 #include "spanner.hh"
  14 #include "lookup.hh"
  15 #include "output-def.hh"
  16 #include "rhythmic-head.hh"
  17 #include "bezier.hh"
  18 #include "paper-column.hh"
  19 #include "warn.hh"
  20 #include "staff-symbol-referencer.hh"
  21 #include "directional-element-interface.hh"
  22 #include "bezier.hh"
  23 #include "stem.hh"
  24 #include "note-head.hh"
  25 #include "tie-column.hh"
  26
  27 /*
  28   tie: Connect two noteheads.
  29
  30   What if we have
  31
  32   c4 ~ \clef bass ; c4 or
  33
  34   c4 \staffchange c4
  35
  36   do we have non-horizontal ties then?
  37 */
  38
  39 void
  40 Tie::set_head (Grob *me, Direction d, Grob *h)
  41 {
  42   assert (!head (me, d));
  43   index_set_cell (me->get_property ("head-pair"), d, h->self_scm ());
  44
  45   dynamic_cast<Spanner *> (me)->set_bound (d, h);
  46   me->add_dependency (h);
  47 }
  48
  49 void
  50 Tie::set_interface (Grob *me)
  51 {
  52   me->set_property ("head-pair", scm_cons (SCM_EOL, SCM_EOL));
  53 }
  54
  55 Grob *
  56 Tie::head (Grob *me, Direction d)
  57 {
  58   SCM c = me->get_property ("head-pair");
  59
  60   if (scm_is_pair (c))
  61     return unsmob_grob (index_get_cell (c, d));
  62   else
  63     return 0;
  64 }
  65
  66 int
  67 Tie::get_column_rank (Grob *me, Direction d)
  68 {
  69   Spanner *span = dynamic_cast<Spanner *> (me);
  70   Grob *h = head (me, d);
  71   if (!h)
  72     h = span->get_bound (d);
  73
  74   Grob *col = dynamic_cast<Item *> (h)->get_column ();
  75   return Paper_column::get_rank (col);
  76 }
  77
  78 Real
  79 Tie::get_position (Grob *me)
  80 {
  81   Direction d = head (me, LEFT) ? LEFT : RIGHT;
  82   return Staff_symbol_referencer::get_position (head (me, d));
  83 }
  84
  85 /*
  86   Default:  Put the tie oppositie of the stem [Wanske p231]
  87
  88   In case of chords: Tie_column takes over
  89
  90   The direction of the Tie is more complicated (See [Ross] p136 and
  91   further).
  92
  93   (what about linebreaks? )
  94 */
  95 Direction
  96 Tie::get_default_dir (Grob *me)
  97 {
  98   Item *sl = head (me, LEFT) ? Rhythmic_head::get_stem (head (me, LEFT)) : 0;
  99   Item *sr = head (me, RIGHT) ? Rhythmic_head::get_stem (head (me, RIGHT)) : 0;
 100   if (sl && sr)
 101     {
 102       if (get_grob_direction (sl) == UP
 103           && get_grob_direction (sr) == UP)
 104         return DOWN;
 105     }
 106   else if (sl || sr)
 107     {
 108       Item *s = sl ? sl : sr;
 109       return -get_grob_direction (s);
 110     }
 111
 112   return UP;
 113 }
 114
 115 void
 116 Tie::set_direction (Grob *me)
 117 {
 118   if (!get_grob_direction (me))
 119     {
 120       if (Tie_column::has_interface (me->get_parent (Y_AXIS)))
 121         Tie_column::set_directions (me->get_parent (Y_AXIS));
 122       else
 123         set_grob_direction (me, Tie::get_default_dir (me));
 124     }
 125 }
 126
 127
 128 SCM
 129 Tie::get_control_points (SCM smob)
 130 {
 131   Spanner *me = unsmob_spanner (smob);
 132   if (!head (me, LEFT) && !head (me, RIGHT))
 133     {
 134       programming_error ("tie without heads");
 135       me->suicide ();
 136       return SCM_EOL;
 137     }
 138
 139   set_direction (me);
 140   int tie_position = (int) Tie::get_position (me);
 141
 142   Direction dir = get_grob_direction (me);
 143
 144   Real staff_space = Staff_symbol_referencer::staff_space (me);
 145   Real staff_position = tie_position;
 146
 147   Grob *common[NO_AXES];
 148   for (int a = X_AXIS; a < NO_AXES; a++)
 149     {
 150       Axis ax ((Axis) a);
 151       common[ax] = me->get_bound (LEFT)->common_refpoint (me, ax);
 152       common[ax] = me->get_bound (RIGHT)->common_refpoint (common[a], ax);
 153     }
 154
 155   Interval attachments;
 156
 157   Direction d = LEFT;
 158   Real gap = robust_scm2double (me->get_property ("x-gap"), 0.2);
 159   do
 160     {
 161       attachments[d]
 162         = robust_relative_extent (me->get_bound (d),
 163                                   common[X_AXIS],
 164                                   X_AXIS)[-d]
 165         - gap * d;
 166     }
 167   while (flip (&d) != LEFT);
 168
 169   bool in_between = true;
 170   if (attachments.length () < 0.6 * staff_space)
 171     {
 172       /*
 173         Let short ties start over note heads, instead of between.
 174        */
 175       Drul_array<bool> allow (true, true);
 176
 177       Direction d = LEFT;
 178       do {
 179         if (Note_head::has_interface (me->get_bound (d)))
 180           {
 181             Grob *stem = unsmob_grob (me->get_bound (d)->get_object ("stem"));
 182             if (get_grob_direction (stem) == dir
 183                 && -d == dir)
 184               allow[d] = false;
 185           }
 186       } while (flip (&d) != LEFT);
 187
 188       if (allow[LEFT] && allow[RIGHT])
 189         {
 190           staff_position += dir;
 191           do
 192             {
 193               if (Note_head::has_interface (me->get_bound (d)))
 194                 {
 195                   Interval extent
 196                     = robust_relative_extent (me->get_bound (d),
 197                                               common[X_AXIS], X_AXIS);
 198
 199                   attachments[d] = extent.linear_combination (- 0.5 * d);
 200                   in_between = false;
 201                 }
 202             }
 203           while (flip (&d) != LEFT);
 204         }
 205     }
 206
 207   SCM details = me->get_property ("details");
 208
 209   SCM limit
 210     = scm_assq (ly_symbol2scm ("height-limit"), details);
 211
 212   Real h_inf = robust_scm2double (scm_cdr (limit), 0.75) * staff_space;
 213   Real r_0 = robust_scm2double (scm_cdr (scm_assq (ly_symbol2scm ("ratio"), details)),
 214                                 .333);
 215
 216   Bezier b = slur_shape (attachments.length(),
 217                          h_inf, r_0);
 218   b.scale (1, dir);
 219
 220   Offset middle = b.curve_point (0.5);
 221   Offset edge = b.curve_point (0.0);
 222
 223   staff_position = rint (staff_position);
 224
 225   Real dy = fabs (middle[Y_AXIS] - edge[Y_AXIS]);
 226   bool in_space = !(Staff_symbol_referencer::on_staffline (me, (int) staff_position));
 227   bool fits_in_space =
 228     (dy < 0.6 * staff_space);
 229
 230   /*
 231     Avoid dot
 232    */
 233   Grob *left_dot = unsmob_grob (me->get_bound (LEFT)->get_object ("dot"));
 234   if (left_dot && in_space)
 235     {
 236       if (staff_position == Staff_symbol_referencer::get_position (left_dot))
 237         {
 238           staff_position += dir;
 239           in_space = false;
 240         }
 241     }
 242
 243   /*
 244     Avoid flag.
 245    */
 246   Grob *left_stem = unsmob_grob (me->get_bound (LEFT)->get_object ("stem"));
 247   if (left_stem)
 248     {
 249       Stencil flag = Stem::get_translated_flag (left_stem);
 250       Real y = staff_position * staff_space * 0.5;
 251       if (flag.extent (Y_AXIS).contains (y))
 252         {
 253           staff_position += dir;
 254           in_space = !in_space;
 255         }
 256     }
 257
 258   /*
 259     Putting larger in-space ties next to the notes forces
 260     the edges to be opposite (Y-wise) to the tie direction.
 261    */
 262   if (staff_position == tie_position
 263       && in_space
 264       && dy > 0.3 * staff_space)
 265     {
 266       staff_position += 2 * dir;
 267     }
 268
 269   if (in_space != fits_in_space)
 270     {
 271       if (in_space)
 272         {
 273           staff_position += dir;
 274         }
 275       else
 276         {
 277           in_space = true;
 278           staff_position += dir;
 279         }
 280     }
 281
 282   if (!in_between
 283       && in_space
 284       && fabs (staff_position - tie_position) <= 1)
 285     staff_position += 2*dir;
 286
 287
 288   if (in_space)
 289     {
 290       if (fabs (dy) < 0.4 * staff_space)
 291         {
 292           /*
 293             vertically center in space.
 294           */
 295           Offset middle = b.curve_point (0.5);
 296           Offset edge = b.curve_point (0.0);
 297
 298           Real center = (edge[Y_AXIS] + middle[Y_AXIS])/2.0;
 299           b.translate (Offset (0,
 300                                staff_position * staff_space * 0.5
 301                                - center));
 302         }
 303       else
 304         {
 305           b.translate (Offset (0,
 306                                (staff_position - dir) * staff_space * 0.5
 307                                + dir * 0.2 * staff_space));
 308         }
 309     }
 310   else
 311     {
 312       Real where = 0.5 * dir;
 313
 314       Real rounding_dy = (where - middle[Y_AXIS]);
 315       b.translate (Offset (0,
 316                            0.5 * staff_position * staff_space + rounding_dy));
 317
 318       if (dir * b.curve_point (0.0)[Y_AXIS] <
 319           dir * tie_position * 0.5 * staff_space)
 320         b.translate (Offset (0, staff_space * dir));
 321     }
 322
 323   b.translate (Offset (attachments[LEFT]
 324                        - me->relative_coordinate (common[X_AXIS], X_AXIS), 0));
 325
 326   SCM controls = SCM_EOL;
 327   for (int i = 4; i--;)
 328     controls = scm_cons (ly_offset2scm (b.control_[i]), controls);
 329   return controls;
 330 }
 331
 332
 333
 334 MAKE_SCHEME_CALLBACK (Tie, print, 1);
 335 SCM
 336 Tie::print (SCM smob)
 337 {
 338   Grob *me = unsmob_grob (smob);
 339
 340   SCM cp = me->get_property ("control-points");
 341   if (!scm_is_pair (cp))                // list is more accurate
 342     {
 343       cp = get_control_points (smob);
 344       me->set_property ("control-points", cp);
 345     }
 346
 347   if (!scm_is_pair (cp))
 348     return Stencil ().smobbed_copy ();
 349
 350   Real staff_thick = Staff_symbol_referencer::line_thickness (me);
 351   Real base_thick = robust_scm2double (me->get_property ("thickness"), 1);
 352   Real thick = base_thick * staff_thick;
 353
 354   Bezier b;
 355   int i = 0;
 356   for (SCM s = cp; s != SCM_EOL; s = scm_cdr (s))
 357     {
 358       b.control_[i] = ly_scm2offset (scm_car (s));
 359       i++;
 360     }
 361
 362   Stencil a;
 363
 364   SCM p = me->get_property ("dash-period");
 365   SCM f = me->get_property ("dash-fraction");
 366   if (scm_is_number (p) && scm_is_number (f))
 367     a = Lookup::dashed_slur (b,
 368                              thick,
 369                              robust_scm2double (p, 1.0),
 370                              robust_scm2double (f, 0));
 371   else
 372     a = Lookup::slur (b,
 373                       get_grob_direction (me) * staff_thick,
 374                       thick);
 375
 376   return a.smobbed_copy ();
 377 }
 378
 379 ADD_INTERFACE (Tie,
 380                "tie-interface",
 381                "A tie connecting two noteheads.\n",
 382
 383                "control-points "
 384                "dash-fraction"
 385                "dash-period "
 386                "details "
 387                "direction "
 388                "head-pair "
 389                "thickness "
 390                "x-gap ");