lily/slur-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "context.hh"
  21 #include "directional-element-interface.hh"
  22 #include "international.hh"
  23 #include "note-column.hh"
  24 #include "pointer-group-interface.hh"
  25 #include "slur-engraver.hh"
  26 #include "slur.hh"
  27 #include "spanner.hh"
  28 #include "warn.hh"
  29
  30 #include "translator.icc"
  31
  32 SCM
  33 Slur_engraver::event_symbol () const
  34 {
  35   return ly_symbol2scm ("slur-event");
  36 }
  37
  38 bool
  39 Slur_engraver::double_property () const
  40 {
  41   return to_boolean (get_property ("doubleSlurs"));
  42 }
  43
  44 SCM
  45 Slur_engraver::grob_symbol () const
  46 {
  47   return ly_symbol2scm ("Slur");
  48 }
  49
  50 const char *
  51 Slur_engraver::object_name () const
  52 {
  53   return "slur";
  54 }
  55
  56 Slur_engraver::Slur_engraver ()
  57 {
  58 }
  59
  60 void
  61 Slur_engraver::set_melisma (bool m)
  62 {
  63   context ()->set_property ("slurMelismaBusy", ly_bool2scm (m));
  64 }
  65
  66 void
  67 Slur_engraver::boot ()
  68 {
  69   ADD_LISTENER (Slur_engraver, slur);
  70   ADD_LISTENER (Slur_engraver, note);
  71   ADD_ACKNOWLEDGER_FOR (Slur_engraver, extra_object, inline_accidental);
  72   ADD_ACKNOWLEDGER_FOR (Slur_engraver, extra_object, fingering);
  73   ADD_ACKNOWLEDGER (Slur_engraver, note_column);
  74   ADD_ACKNOWLEDGER (Slur_engraver, script);
  75   ADD_ACKNOWLEDGER_FOR (Slur_engraver, extra_object, text_script);
  76   ADD_ACKNOWLEDGER_FOR (Slur_engraver, extra_object, dots);
  77   ADD_END_ACKNOWLEDGER (Slur_engraver, tie);
  78   ADD_ACKNOWLEDGER_FOR (Slur_engraver, extra_object, tuplet_number);
  79 }
  80
  81 ADD_TRANSLATOR (Slur_engraver,
  82                 /* doc */
  83                 "Build slur grobs from slur events.",
  84
  85                 /* create */
  86                 "Slur ",
  87
  88                 /* read */
  89                 "slurMelismaBusy "
  90                 "doubleSlurs ",
  91
  92                 /* write */
  93                 ""
  94                );
  95
  96 void
  97 Slur_engraver::derived_mark () const
  98 {
  99   for (vsize i = start_events_.size (); i--;)
 100     {
 101       scm_gc_mark (start_events_[i].slur_->self_scm ());
 102       if (start_events_[i].note_)
 103         scm_gc_mark (start_events_[i].note_->self_scm ());
 104     }
 105   for (vsize i = stop_events_.size (); i--;)
 106     {
 107       scm_gc_mark (stop_events_[i].slur_->self_scm ());
 108       if (stop_events_[i].note_)
 109         scm_gc_mark (stop_events_[i].note_->self_scm ());
 110     }
 111 }
 112
 113 void
 114 Slur_engraver::listen_note_slur (Stream_event *ev, Stream_event *note)
 115 {
 116   Direction d = to_dir (ev->get_property ("span-direction"));
 117   if (d == START)
 118     start_events_.push_back (Event_info (ev, note));
 119   else if (d == STOP)
 120     stop_events_.push_back (Event_info (ev, note));
 121   else ev->origin ()->warning (_f ("direction of %s invalid: %d",
 122                                    ev->name ().c_str (),
 123                                    int (d)));
 124 }
 125
 126 void
 127 Slur_engraver::listen_note (Stream_event *ev)
 128 {
 129   for (SCM arts = ev->get_property ("articulations");
 130        scm_is_pair (arts); arts = scm_cdr (arts))
 131     {
 132       Stream_event *art = unsmob<Stream_event> (scm_car (arts));
 133       if (art->in_event_class (event_symbol ()))
 134         listen_note_slur (art, ev);
 135     }
 136 }
 137
 138 void
 139 Slur_engraver::acknowledge_note_column (Grob_info info)
 140 {
 141   Grob *e = info.grob ();
 142   for (vsize i = slurs_.size (); i--;)
 143     Slur::add_column (slurs_[i], e);
 144   for (vsize i = end_slurs_.size (); i--;)
 145     Slur::add_column (end_slurs_[i], e);
 146   // Now cater for slurs starting/ending at a notehead: those override
 147   // the column bounds
 148   if (note_slurs_[START].empty () && note_slurs_[STOP].empty ())
 149     return;
 150   extract_grob_set (e, "note-heads", heads);
 151   for (vsize i = heads.size (); i--;)
 152     {
 153       if (Stream_event *ev =
 154           unsmob<Stream_event> (heads[i]->get_property ("cause")))
 155         for (LEFT_and_RIGHT (d))
 156           {
 157             std::pair<Note_slurs::const_iterator, Note_slurs::const_iterator> its
 158               = note_slurs_[d].equal_range (ev);
 159             for (Note_slurs::const_iterator it = its.first;
 160                  it != its.second;
 161                  ++it)
 162               it->second->set_bound (d, heads[i]);
 163           }
 164     }
 165 }
 166
 167 void
 168 Slur_engraver::acknowledge_extra_object (Grob_info info)
 169 {
 170   objects_to_acknowledge_.push_back (info);
 171 }
 172
 173 void
 174 Slur_engraver::acknowledge_script (Grob_info info)
 175 {
 176   if (!info.grob ()->internal_has_interface (ly_symbol2scm ("dynamic-interface")))
 177     acknowledge_extra_object (info);
 178 }
 179
 180 void
 181 Slur_engraver::acknowledge_end_tie (Grob_info info)
 182 {
 183   acknowledge_extra_object (info);
 184 }
 185
 186 void
 187 Slur_engraver::finalize ()
 188 {
 189   for (vsize i = 0; i < slurs_.size (); i++)
 190     {
 191       slurs_[i]->warning (_f ("unterminated %s", object_name ()));
 192       slurs_[i]->suicide ();
 193     }
 194   slurs_.clear ();
 195 }
 196
 197 void
 198 Slur_engraver::create_slur (const string &spanner_id, Event_info evi, Grob *g_cause, Direction dir, bool left_broken)
 199 {
 200   Grob *ccc = left_broken
 201     ? unsmob<Grob> (get_property ("currentCommandColumn"))
 202     : 0; // efficiency
 203   SCM cause = evi.slur_ ? evi.slur_->self_scm () : g_cause->self_scm ();
 204   Spanner *slur = make_spanner (grob_symbol (), cause);
 205   slur->set_property ("spanner-id", ly_string2scm (spanner_id));
 206   if (dir)
 207     set_grob_direction (slur, dir);
 208   if (left_broken)
 209     slur->set_bound (LEFT, ccc);
 210   slurs_.push_back (slur);
 211   if (evi.note_)
 212     note_slurs_[START].insert (Note_slurs::value_type (evi.note_, slur));
 213
 214   if (double_property ())
 215   {
 216     set_grob_direction (slur, DOWN);
 217     slur = make_spanner (grob_symbol (), cause);
 218     slur->set_property ("spanner-id", ly_string2scm (spanner_id));
 219     set_grob_direction (slur, UP);
 220     if (left_broken)
 221       slur->set_bound (LEFT, ccc);
 222     slurs_.push_back (slur);
 223     if (evi.note_)
 224       note_slurs_[START].insert(Note_slurs::value_type (evi.note_, slur));
 225   }
 226
 227 }
 228
 229 bool
 230 Slur_engraver::can_create_slur (const string &id, vsize old_slurs, vsize *event_idx, Stream_event *ev)
 231 {
 232   for (vsize j = slurs_.size (); j--;)
 233     {
 234       Grob *slur = slurs_[j];
 235       Direction updown = to_dir (ev->get_property ("direction"));
 236
 237       // Check if we already have a slur with the same spanner-id.
 238       if (id == robust_scm2string (slur->get_property ("spanner-id"), ""))
 239         {
 240           if (j < old_slurs)
 241             {
 242               // We already have an old slur, so give a warning
 243               // and completely ignore the new slur.
 244               ev->origin ()->warning (_f ("already have %s", object_name ()));
 245               if (event_idx)
 246                 start_events_.erase (start_events_.begin () + (*event_idx));
 247               return false;
 248             }
 249
 250           // If this slur event has no direction, it will not
 251           // contribute anything new to the existing slur(s), so
 252           // we can ignore it.
 253
 254           if (!updown)
 255             return false;
 256
 257           Stream_event *c = unsmob<Stream_event> (slur->get_property ("cause"));
 258
 259           if (!c)
 260             {
 261               slur->programming_error (_f ("%s without a cause", object_name ()));
 262               return true;
 263             }
 264
 265           Direction slur_dir = to_dir (c->get_property ("direction"));
 266
 267           // If the existing slur does not have a direction yet,
 268           // we'd rather take the new one.
 269
 270           if (!slur_dir)
 271             {
 272               slur->suicide ();
 273               slurs_.erase (slurs_.begin () + j);
 274               return true;
 275             }
 276
 277           // If the existing slur has the same direction as ours, drop ours
 278
 279           if (slur_dir == updown)
 280             return false;
 281         }
 282     }
 283   return true;
 284 }
 285
 286 bool
 287 Slur_engraver::try_to_end (Event_info evi)
 288 {
 289   string id = robust_scm2string (evi.slur_->get_property ("spanner-id"), "");
 290
 291   // Find the slurs that are ended with this event (by checking the spanner-id)
 292   bool ended = false;
 293   for (vsize j = slurs_.size (); j--;)
 294     {
 295       if (id == robust_scm2string (slurs_[j]->get_property ("spanner-id"), ""))
 296         {
 297           ended = true;
 298           end_slurs_.push_back (slurs_[j]);
 299           if (evi.note_)
 300             note_slurs_[STOP].insert
 301               (Note_slurs::value_type
 302                (evi.note_, dynamic_cast <Spanner *> (slurs_[j])));
 303           slurs_.erase (slurs_.begin () + j);
 304         }
 305     }
 306   return ended;
 307 }
 308
 309 void
 310 Slur_engraver::process_music ()
 311 {
 312   for (vsize i = 0; i < stop_events_.size (); i++)
 313     {
 314       string id = robust_scm2string
 315         (stop_events_[i].slur_->get_property ("spanner-id"), "");
 316       bool ended = try_to_end (stop_events_[i]);
 317       if (ended)
 318         {
 319           // Ignore redundant stop events for this id
 320           for (vsize j = stop_events_.size (); --j > i;)
 321             {
 322               if (id == robust_scm2string
 323                   (stop_events_[j].slur_->get_property ("spanner-id"), ""))
 324                 stop_events_.erase (stop_events_.begin () + j);
 325             }
 326         }
 327       else
 328         stop_events_[i].slur_->origin ()->warning (_f ("cannot end %s", object_name ()));
 329     }
 330
 331   vsize old_slurs = slurs_.size ();
 332   for (vsize i = start_events_.size (); i--;)
 333     {
 334       Stream_event *ev = start_events_[i].slur_;
 335       string id = robust_scm2string (ev->get_property ("spanner-id"), "");
 336       Direction updown = to_dir (ev->get_property ("direction"));
 337
 338       if (can_create_slur (id, old_slurs, &i, ev))
 339         create_slur (id, start_events_[i], 0, updown, false);
 340     }
 341
 342   set_melisma (slurs_.size ());
 343 }
 344
 345 void
 346 Slur_engraver::stop_translation_timestep ()
 347 {
 348   if (Grob *g = unsmob<Grob> (get_property ("currentCommandColumn")))
 349     {
 350       for (vsize i = 0; i < end_slurs_.size (); i++)
 351         Slur::add_extra_encompass (end_slurs_[i], g);
 352
 353       if (!start_events_.size ())
 354         for (vsize i = 0; i < slurs_.size (); i++)
 355           Slur::add_extra_encompass (slurs_[i], g);
 356     }
 357
 358   for (vsize i = 0; i < end_slurs_.size (); i++)
 359     {
 360       Spanner *s = dynamic_cast<Spanner *> (end_slurs_[i]);
 361       if (!s->get_bound (RIGHT))
 362         s->set_bound (RIGHT, unsmob<Grob> (get_property ("currentMusicalColumn")));
 363       announce_end_grob (s, SCM_EOL);
 364     }
 365
 366   for (vsize i = 0; i < objects_to_acknowledge_.size (); i++)
 367     Slur::auxiliary_acknowledge_extra_object (objects_to_acknowledge_[i], slurs_, end_slurs_);
 368
 369   note_slurs_[LEFT].clear ();
 370   note_slurs_[RIGHT].clear ();
 371   objects_to_acknowledge_.clear ();
 372   end_slurs_.clear ();
 373   start_events_.clear ();
 374   stop_events_.clear ();
 375 }