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@xs4all.nl>
   7 */
   8
   9 #include "tie.hh"
  10 #include "spanner.hh"
  11 #include "lookup.hh"
  12 #include "output-def.hh"
  13 #include "rhythmic-head.hh"
  14 #include "bezier.hh"
  15 #include "paper-column.hh"
  16 #include "warn.hh"
  17 #include "staff-symbol-referencer.hh"
  18 #include "directional-element-interface.hh"
  19 #include "bezier.hh"
  20 #include "stem.hh"
  21 #include "note-head.hh"
  22 #include "tie-column.hh"
  23 #include "grob-array.hh"
  24 #include "tie-formatting-problem.hh"
  25 #include "tie-configuration.hh"
  26
  27
  28 int
  29 Tie::compare (Grob *const &s1,
  30               Grob *const &s2)
  31 {
  32   return sign (Tie::get_position (s1) - Tie::get_position (s2));
  33 }
  34
  35 void
  36 Tie::set_head (Grob *me, Direction d, Grob *h)
  37 {
  38   dynamic_cast<Spanner *> (me)->set_bound (d, h);
  39 }
  40
  41 Grob *
  42 Tie::head (Grob *me, Direction d)
  43 {
  44   Item *it = dynamic_cast<Spanner*> (me)->get_bound (d);
  45   if (Note_head::has_interface (it))
  46     return it;
  47   else
  48     return 0;
  49 }
  50
  51 int
  52 Tie::get_column_rank (Grob *me, Direction d)
  53 {
  54   Spanner *span = dynamic_cast<Spanner *> (me);
  55   Grob *h = head (me, d);
  56   if (!h)
  57     h = span->get_bound (d);
  58
  59   Grob *col = dynamic_cast<Item *> (h)->get_column ();
  60   return Paper_column::get_rank (col);
  61 }
  62
  63 int
  64 Tie::get_position (Grob *me)
  65 {
  66   Direction d = LEFT;
  67   do
  68     {
  69       Grob *h = head (me, d);
  70       if (h)
  71         return (int) Staff_symbol_referencer::get_position (h);
  72     }
  73   while (flip (&d) != LEFT);
  74
  75   /*
  76
  77   TODO: this is theoretically possible for ties across more than 2
  78   systems.. We should look at the first broken copy.
  79
  80   */
  81   programming_error ("Tie without heads. Suicide");
  82   me->suicide ();
  83   return 0;
  84 }
  85
  86 /*
  87   Default:  Put the tie oppositie of the stem [Wanske p231]
  88
  89   In case of chords: Tie_column takes over
  90
  91   The direction of the Tie is more complicated (See [Ross] p136 and
  92   further).
  93
  94   (what about linebreaks? )
  95 */
  96 Direction
  97 Tie::get_default_dir (Grob *me)
  98 {
  99   Item *sl = head (me, LEFT) ? Rhythmic_head::get_stem (head (me, LEFT)) : 0;
 100   Item *sr = head (me, RIGHT) ? Rhythmic_head::get_stem (head (me, RIGHT)) : 0;
 101   if (sl && sr)
 102     {
 103       if (get_grob_direction (sl) == UP
 104           && get_grob_direction (sr) == UP)
 105         return DOWN;
 106     }
 107   else if (sl || sr)
 108     {
 109       Item *s = sl ? sl : sr;
 110       return -get_grob_direction (s);
 111     }
 112
 113   return UP;
 114 }
 115
 116
 117 MAKE_SCHEME_CALLBACK(Tie, calc_direction, 1);
 118 SCM
 119 Tie::calc_direction (SCM smob)
 120 {
 121   Grob *me = unsmob_grob (smob);
 122   Grob *yparent = me->get_parent (Y_AXIS);
 123   if (Tie_column::has_interface (yparent)
 124       && unsmob_grob_array (yparent->get_object ("ties"))
 125       && unsmob_grob_array (yparent->get_object ("ties"))->size () > 1)
 126     {
 127       /* trigger positioning. */
 128       (void) yparent->get_property ("positioning-done");
 129     }
 130   else
 131     set_grob_direction (me, Tie::get_default_dir (me));
 132
 133   return SCM_UNSPECIFIED;
 134 }
 135
 136
 137 void
 138 Tie::set_default_control_points (Grob *me_grob)
 139 {
 140   Spanner *me = dynamic_cast<Spanner*> (me_grob);
 141   Grob *common  = me;
 142   common = me->get_bound (LEFT)->common_refpoint (common, X_AXIS);
 143   common = me->get_bound (RIGHT)->common_refpoint (common, X_AXIS);
 144
 145   Tie_formatting_problem problem;
 146   problem.from_tie (me);
 147
 148   // get_configuration (me,  &conf, problem);
 149   int tie_position = (int) Tie::get_position (me);
 150   Tie_configuration conf
 151     = problem.find_optimal_tie_configuration (tie_position, get_grob_direction (me));
 152   set_control_points (me, problem.common_x_refpoint (),
 153                       conf, problem.details_);
 154 }
 155
 156 void
 157 Tie::set_control_points (Grob *me,
 158                          Grob *common,
 159                          Tie_configuration const &conf,
 160                          Tie_details const &details
 161                          )
 162 {
 163   Bezier b = conf.get_transformed_bezier (details);
 164   b.translate (Offset (- me->relative_coordinate (common, X_AXIS), 0));
 165
 166   SCM controls = SCM_EOL;
 167   for (int i = 4; i--;)
 168     {
 169       if (!b.control_[i].is_sane ())
 170         programming_error ("Insane offset");
 171       controls = scm_cons (ly_offset2scm (b.control_[i]), controls);
 172     }
 173   me->set_property ("control-points", controls);
 174 }
 175
 176 MAKE_SCHEME_CALLBACK(Tie, calc_control_points, 1);
 177 SCM
 178 Tie::calc_control_points (SCM smob)
 179 {
 180   Grob *me = unsmob_grob (smob);
 181
 182   // trigger Tie-column
 183   (void)  get_grob_direction (me);
 184
 185   Grob *yparent = me->get_parent (Y_AXIS);
 186   if (Tie_column::has_interface (yparent)
 187       && unsmob_grob_array (yparent->get_object ("ties"))
 188       && unsmob_grob_array (yparent->get_object ("ties"))->size () > 1)
 189     {
 190       /* trigger positioning. */
 191       (void) yparent->get_property ("positioning-done");
 192     }
 193
 194   if (!scm_is_pair (me->get_property ("control-points")))
 195     {
 196       set_default_control_points (me);
 197     }
 198
 199   return SCM_UNSPECIFIED;
 200 }
 201
 202
 203 MAKE_SCHEME_CALLBACK (Tie, print, 1);
 204 SCM
 205 Tie::print (SCM smob)
 206 {
 207   Grob *me = unsmob_grob (smob);
 208
 209   SCM cp = me->get_property ("control-points");
 210
 211   Real staff_thick = Staff_symbol_referencer::line_thickness (me);
 212   Real base_thick = robust_scm2double (me->get_property ("thickness"), 1);
 213   Real thick = base_thick * staff_thick;
 214
 215   Bezier b;
 216   int i = 0;
 217   for (SCM s = cp; s != SCM_EOL; s = scm_cdr (s))
 218     {
 219       b.control_[i] = ly_scm2offset (scm_car (s));
 220       i++;
 221     }
 222
 223   Stencil a;
 224
 225   SCM p = me->get_property ("dash-period");
 226   SCM f = me->get_property ("dash-fraction");
 227   if (scm_is_number (p) && scm_is_number (f))
 228     a = Lookup::dashed_slur (b,
 229                              thick,
 230                              robust_scm2double (p, 1.0),
 231                              robust_scm2double (f, 0));
 232   else
 233     a = Lookup::slur (b,
 234                       get_grob_direction (me) * staff_thick,
 235                       thick);
 236
 237   return a.smobbed_copy ();
 238 }
 239
 240 ADD_INTERFACE (Tie,
 241                "tie-interface",
 242
 243                "A tie connecting two noteheads. \n\n"
 244                ,
 245
 246
 247                /* properties */
 248                "avoid-slur "    //  UGH.
 249                "control-points "
 250                "dash-fraction "
 251                "dash-period "
 252                "details "
 253                "direction "
 254                "thickness "
 255                "x-gap ");
 256
 257
 258
 259