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
  11 #include "main.hh"
  12 #include "bezier.hh"
  13 #include "directional-element-interface.hh"
  14 #include "font-interface.hh"
  15 #include "grob-array.hh"
  16 #include "lookup.hh"
  17 #include "note-head.hh"
  18 #include "output-def.hh"
  19 #include "paper-column.hh"
  20 #include "rhythmic-head.hh"
  21 #include "spanner.hh"
  22 #include "staff-symbol-referencer.hh"
  23 #include "stem.hh"
  24 #include "text-interface.hh"
  25 #include "tie-column.hh"
  26 #include "tie-configuration.hh"
  27 #include "tie-formatting-problem.hh"
  28 #include "warn.hh"
  29 #include "semi-tie-column.hh"
  30
  31
  32 bool
  33 Tie::less (Grob *const &s1,
  34            Grob *const &s2)
  35 {
  36   return Tie::get_position (s1) < Tie::get_position (s2);
  37 }
  38
  39 void
  40 Tie::set_head (Grob *me, Direction d, Grob *h)
  41 {
  42   dynamic_cast<Spanner *> (me)->set_bound (d, h);
  43 }
  44
  45 Grob *
  46 Tie::head (Grob *me, Direction d)
  47 {
  48   if (is_direction (me->get_property ("head-direction")))
  49      {
  50        Direction hd = to_dir (me->get_property ("head-direction"));
  51
  52        return (hd == d)
  53          ? unsmob_grob (me->get_object ("note-head"))
  54          : 0;
  55      }
  56
  57   Item *it = dynamic_cast<Spanner*> (me)->get_bound (d);
  58   if (Note_head::has_interface (it))
  59     return it;
  60   else
  61     return 0;
  62 }
  63
  64 int
  65 Tie::get_column_rank (Grob *me, Direction d)
  66 {
  67   Spanner *span = dynamic_cast<Spanner *> (me);
  68   Grob *h = head (me, d);
  69   if (!h)
  70     h = span->get_bound (d);
  71
  72   Grob *col = dynamic_cast<Item *> (h)->get_column ();
  73   return Paper_column::get_rank (col);
  74 }
  75
  76 int
  77 Tie::get_position (Grob *me)
  78 {
  79   Direction d = LEFT;
  80   do
  81     {
  82       Grob *h = head (me, d);
  83       if (h)
  84         return (int) rint (Staff_symbol_referencer::get_position (h));
  85     }
  86   while (flip (&d) != LEFT);
  87
  88   /*
  89
  90   TODO: this is theoretically possible for ties across more than 2
  91   systems.. We should look at the first broken copy.
  92
  93   */
  94   programming_error ("Tie without heads. Suicide");
  95   me->suicide ();
  96   return 0;
  97 }
  98
  99 /*
 100   Default:  Put the tie oppositie of the stem [Wanske p231]
 101
 102   In case of chords: Tie_column takes over
 103
 104   The direction of the Tie is more complicated (See [Ross] p136 and
 105   further).
 106
 107   (what about linebreaks? )
 108 */
 109 Direction
 110 Tie::get_default_dir (Grob *me)
 111 {
 112   Drul_array<Grob*> stems;
 113   Direction d = LEFT;
 114   do
 115     {
 116       Grob *stem = head (me, d) ? Rhythmic_head::get_stem (head (me, d)) : 0;
 117       if (stem)
 118         stem = Stem::is_invisible (stem) ? 0 : stem;
 119
 120       stems[d] = stem;
 121     }
 122   while (flip (&d)!= LEFT);
 123
 124   if (stems[LEFT] && stems[RIGHT])
 125     {
 126       if (get_grob_direction (stems[LEFT]) == UP
 127           && get_grob_direction (stems[RIGHT]) == UP)
 128         return DOWN;
 129     }
 130   else if (stems[LEFT] || stems[RIGHT])
 131     {
 132       Grob *s = stems[LEFT] ? stems[LEFT] : stems[RIGHT];
 133       return -get_grob_direction (s);
 134     }
 135   else if (int p = get_position (me))
 136     return Direction (sign (p));
 137
 138   return UP;
 139 }
 140
 141
 142 MAKE_SCHEME_CALLBACK(Tie, calc_direction, 1);
 143 SCM
 144 Tie::calc_direction (SCM smob)
 145 {
 146   Grob *me = unsmob_grob (smob);
 147   Grob *yparent = me->get_parent (Y_AXIS);
 148   if ((Tie_column::has_interface (yparent)
 149        || Semi_tie_column::has_interface (yparent))
 150       && unsmob_grob_array (yparent->get_object ("ties"))
 151       && unsmob_grob_array (yparent->get_object ("ties"))->size () > 1)
 152     {
 153       /* trigger positioning. */
 154       (void) yparent->get_property ("positioning-done");
 155     }
 156   else
 157     set_grob_direction (me, Tie::get_default_dir (me));
 158
 159   return SCM_UNSPECIFIED;
 160 }
 161
 162
 163 void
 164 Tie::set_default_control_points (Grob *me_grob)
 165 {
 166   Spanner *me = dynamic_cast<Spanner*> (me_grob);
 167   Grob *common  = me;
 168   common = me->get_bound (LEFT)->common_refpoint (common, X_AXIS);
 169   common = me->get_bound (RIGHT)->common_refpoint (common, X_AXIS);
 170
 171   Tie_formatting_problem problem;
 172   problem.from_tie (me);
 173   Tie_specification spec = problem.get_tie_specification (0);
 174   spec.has_manual_dir_ = true;
 175   spec.manual_dir_ = get_grob_direction (me);
 176
 177   if (me->is_live ())
 178     {
 179       Tie_configuration conf
 180         = problem.find_optimal_tie_configuration (spec);
 181
 182       set_control_points (me, problem.common_x_refpoint (),
 183                           conf, problem.details_);
 184     }
 185 }
 186 void
 187 Tie::set_control_points (Grob *me,
 188                          Grob *common,
 189                          Tie_configuration const &conf,
 190                          Tie_details const &details
 191                          )
 192 {
 193   Bezier b = conf.get_transformed_bezier (details);
 194   b.translate (Offset (- me->relative_coordinate (common, X_AXIS), 0));
 195
 196   SCM controls = SCM_EOL;
 197   for (int i = 4; i--;)
 198     {
 199       if (!b.control_[i].is_sane ())
 200         programming_error ("Insane offset");
 201       controls = scm_cons (ly_offset2scm (b.control_[i]), controls);
 202     }
 203   me->set_property ("control-points", controls);
 204 }
 205
 206 MAKE_SCHEME_CALLBACK(Tie, calc_control_points, 1);
 207 SCM
 208 Tie::calc_control_points (SCM smob)
 209 {
 210   Grob *me = unsmob_grob (smob);
 211
 212   // trigger Tie-column
 213   (void)  get_grob_direction (me);
 214
 215   Grob *yparent = me->get_parent (Y_AXIS);
 216   if (Tie_column::has_interface (yparent)
 217       && unsmob_grob_array (yparent->get_object ("ties"))
 218       && unsmob_grob_array (yparent->get_object ("ties"))->size () > 1)
 219     {
 220       /* trigger positioning. */
 221       (void) yparent->get_property ("positioning-done");
 222     }
 223
 224   if (!scm_is_pair (me->get_property_data ("control-points")))
 225     {
 226       set_default_control_points (me);
 227     }
 228
 229   return SCM_UNSPECIFIED;
 230 }
 231
 232 /*
 233   TODO: merge witnh Slur::print.
 234  */
 235 MAKE_SCHEME_CALLBACK (Tie, print, 1);
 236 SCM
 237 Tie::print (SCM smob)
 238 {
 239   Grob *me = unsmob_grob (smob);
 240
 241   SCM cp = me->get_property ("control-points");
 242
 243   Real staff_thick = Staff_symbol_referencer::line_thickness (me);
 244   Real base_thick = staff_thick * robust_scm2double (me->get_property ("thickness"), 1);
 245   Real line_thick = staff_thick * robust_scm2double (me->get_property ("line-thickness"), 1);
 246
 247   Bezier b;
 248   int i = 0;
 249   for (SCM s = cp; scm_is_pair (s); s = scm_cdr (s))
 250     {
 251       b.control_[i] = ly_scm2offset (scm_car (s));
 252       i++;
 253     }
 254
 255   Stencil a;
 256
 257   SCM p = me->get_property ("dash-period");
 258   SCM f = me->get_property ("dash-fraction");
 259   if (scm_is_number (p) && scm_is_number (f))
 260     a = Lookup::dashed_slur (b,
 261                              line_thick,
 262                              robust_scm2double (p, 1.0),
 263                              robust_scm2double (f, 0));
 264   else
 265     a = Lookup::slur (b,
 266                       get_grob_direction (me) * base_thick,
 267                       line_thick);
 268
 269 #if DEBUG_TIE_SCORING
 270   SCM quant_score = me->get_property ("quant-score");
 271
 272   if (to_boolean (me->layout ()
 273                   ->lookup_variable (ly_symbol2scm ("debug-tie-scoring")))
 274       && scm_is_string (quant_score))
 275     {
 276       string str;
 277       SCM properties = Font_interface::text_font_alist_chain (me);
 278
 279       Stencil tm = *unsmob_stencil (Text_interface::interpret_markup
 280                                     (me->layout ()->self_scm (), properties,
 281                                      quant_score));
 282       tm.translate_axis (b.control_[0][Y_AXIS]*2, Y_AXIS);
 283       a.add_at_edge (X_AXIS, RIGHT, tm, 1.0, 0);
 284     }
 285 #endif
 286
 287   return a.smobbed_copy ();
 288 }
 289
 290 ADD_INTERFACE (Tie,
 291                "tie-interface",
 292
 293                "A horizontal curve connecting two noteheads. \n\n"
 294                ,
 295
 296
 297                /* properties */
 298                "avoid-slur "    //  UGH.
 299                "control-points "
 300                "dash-fraction "
 301                "dash-period "
 302                "details "
 303                "direction "
 304                "line-thickness "
 305                "quant-score "
 306                "staff-position "
 307                "thickness "
 308                );
 309
 310
 311
 312