lily/tie.cc

   1 /*
   2   tie.cc -- implement Tie
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2006 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   Tie_specification spec = problem.get_tie_specification (0);
 148   spec.has_manual_dir_ = true;
 149   spec.manual_dir_ = get_grob_direction (me);
 150
 151   Tie_configuration conf
 152     = problem.find_optimal_tie_configuration (spec);
 153
 154   set_control_points (me, problem.common_x_refpoint (),
 155                       conf, problem.details_);
 156 }
 157
 158 void
 159 Tie::set_control_points (Grob *me,
 160                          Grob *common,
 161                          Tie_configuration const &conf,
 162                          Tie_details const &details
 163                          )
 164 {
 165   Bezier b = conf.get_transformed_bezier (details);
 166   b.translate (Offset (- me->relative_coordinate (common, X_AXIS), 0));
 167
 168   SCM controls = SCM_EOL;
 169   for (int i = 4; i--;)
 170     {
 171       if (!b.control_[i].is_sane ())
 172         programming_error ("Insane offset");
 173       controls = scm_cons (ly_offset2scm (b.control_[i]), controls);
 174     }
 175   me->set_property ("control-points", controls);
 176 }
 177
 178 MAKE_SCHEME_CALLBACK(Tie, calc_control_points, 1);
 179 SCM
 180 Tie::calc_control_points (SCM smob)
 181 {
 182   Grob *me = unsmob_grob (smob);
 183
 184   // trigger Tie-column
 185   (void)  get_grob_direction (me);
 186
 187   Grob *yparent = me->get_parent (Y_AXIS);
 188   if (Tie_column::has_interface (yparent)
 189       && unsmob_grob_array (yparent->get_object ("ties"))
 190       && unsmob_grob_array (yparent->get_object ("ties"))->size () > 1)
 191     {
 192       /* trigger positioning. */
 193       (void) yparent->get_property ("positioning-done");
 194     }
 195
 196   if (!scm_is_pair (me->get_property ("control-points")))
 197     {
 198       set_default_control_points (me);
 199     }
 200
 201   return SCM_UNSPECIFIED;
 202 }
 203
 204 /*
 205   TODO: merge witnh Slur::print.
 206  */
 207 MAKE_SCHEME_CALLBACK (Tie, print, 1);
 208 SCM
 209 Tie::print (SCM smob)
 210 {
 211   Grob *me = unsmob_grob (smob);
 212
 213   SCM cp = me->get_property ("control-points");
 214
 215   Real staff_thick = Staff_symbol_referencer::line_thickness (me);
 216   Real base_thick = staff_thick * robust_scm2double (me->get_property ("thickness"), 1);
 217   Real line_thick = staff_thick * robust_scm2double (me->get_property ("line-thickness"), 1);
 218
 219   Bezier b;
 220   int i = 0;
 221   for (SCM s = cp; s != SCM_EOL; s = scm_cdr (s))
 222     {
 223       b.control_[i] = ly_scm2offset (scm_car (s));
 224       i++;
 225     }
 226
 227   Stencil a;
 228
 229   SCM p = me->get_property ("dash-period");
 230   SCM f = me->get_property ("dash-fraction");
 231   if (scm_is_number (p) && scm_is_number (f))
 232     a = Lookup::dashed_slur (b,
 233                              line_thick,
 234                              robust_scm2double (p, 1.0),
 235                              robust_scm2double (f, 0));
 236   else
 237     a = Lookup::slur (b,
 238                       get_grob_direction (me) * base_thick,
 239                       line_thick);
 240
 241   return a.smobbed_copy ();
 242 }
 243
 244 ADD_INTERFACE (Tie,
 245                "tie-interface",
 246
 247                "A horizontal curve connecting two noteheads. \n\n"
 248                ,
 249
 250
 251                /* properties */
 252                "avoid-slur "    //  UGH.
 253                "control-points "
 254                "dash-fraction "
 255                "dash-period "
 256                "details "
 257                "direction "
 258                "line-thickness "
 259                "thickness "
 260                );
 261
 262
 263
 264