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 (Context *c)
  57   : Engraver (c)
  58 {
  59 }
  60
  61 void
  62 Slur_engraver::set_melisma (bool m)
  63 {
  64   context ()->set_property ("slurMelismaBusy", ly_bool2scm (m));
  65 }
  66
  67 void
  68 Slur_engraver::boot ()
  69 {
  70   ADD_LISTENER (Slur_engraver, slur);
  71   ADD_LISTENER (Slur_engraver, note);
  72   ADD_ACKNOWLEDGER_FOR (Slur_engraver, extra_object, inline_accidental);
  73   ADD_ACKNOWLEDGER_FOR (Slur_engraver, extra_object, fingering);
  74   ADD_ACKNOWLEDGER (Slur_engraver, note_column);
  75   ADD_ACKNOWLEDGER (Slur_engraver, script);
  76   ADD_ACKNOWLEDGER_FOR (Slur_engraver, extra_object, text_script);
  77   ADD_ACKNOWLEDGER_FOR (Slur_engraver, extra_object, dots);
  78   ADD_END_ACKNOWLEDGER_FOR (Slur_engraver, extra_object, tie);
  79   ADD_ACKNOWLEDGER_FOR (Slur_engraver, extra_object, tuplet_number);
  80 }
  81
  82 ADD_TRANSLATOR (Slur_engraver,
  83                 /* doc */
  84                 "Build slur grobs from slur events.",
  85
  86                 /* create */
  87                 "Slur ",
  88
  89                 /* read */
  90                 "slurMelismaBusy "
  91                 "doubleSlurs ",
  92
  93                 /* write */
  94                 ""
  95                );
  96
  97 void
  98 Slur_engraver::derived_mark () const
  99 {
 100   for (vsize i = start_events_.size (); i--;)
 101     {
 102       scm_gc_mark (start_events_[i].slur_->self_scm ());
 103       if (start_events_[i].note_)
 104         scm_gc_mark (start_events_[i].note_->self_scm ());
 105     }
 106   for (vsize i = stop_events_.size (); i--;)
 107     {
 108       scm_gc_mark (stop_events_[i].slur_->self_scm ());
 109       if (stop_events_[i].note_)
 110         scm_gc_mark (stop_events_[i].note_->self_scm ());
 111     }
 112 }
 113
 114 void
 115 Slur_engraver::listen_note_slur (Stream_event *ev, Stream_event *note)
 116 {
 117   Direction d = to_dir (ev->get_property ("span-direction"));
 118   if (d == START)
 119     start_events_.push_back (Event_info (ev, note));
 120   else if (d == STOP)
 121     stop_events_.push_back (Event_info (ev, note));
 122   else ev->origin ()->warning (_f ("direction of %s invalid: %d",
 123                                    ev->name ().c_str (),
 124                                    int (d)));
 125 }
 126
 127 void
 128 Slur_engraver::listen_note (Stream_event *ev)
 129 {
 130   for (SCM arts = ev->get_property ("articulations");
 131        scm_is_pair (arts); arts = scm_cdr (arts))
 132     {
 133       Stream_event *art = unsmob<Stream_event> (scm_car (arts));
 134       if (art->in_event_class (event_symbol ()))
 135         listen_note_slur (art, ev);
 136     }
 137 }
 138
 139 void
 140 Slur_engraver::acknowledge_note_column (Grob_info info)
 141 {
 142   Grob *e = info.grob ();
 143   for (vsize i = slurs_.size (); i--;)
 144     Slur::add_column (slurs_[i], e);
 145   for (vsize i = end_slurs_.size (); i--;)
 146     Slur::add_column (end_slurs_[i], e);
 147   // Now cater for slurs starting/ending at a notehead: those override
 148   // the column bounds
 149   if (note_slurs_[START].empty () && note_slurs_[STOP].empty ())
 150     return;
 151   extract_grob_set (e, "note-heads", heads);
 152   for (vsize i = heads.size (); i--;)
 153     {
 154       if (Stream_event *ev =
 155           unsmob<Stream_event> (heads[i]->get_property ("cause")))
 156         for (LEFT_and_RIGHT (d))
 157           {
 158             std::pair<Note_slurs::const_iterator, Note_slurs::const_iterator> its
 159               = note_slurs_[d].equal_range (ev);
 160             for (Note_slurs::const_iterator it = its.first;
 161                  it != its.second;
 162                  ++it)
 163               it->second->set_bound (d, heads[i]);
 164           }
 165     }
 166 }
 167
 168 void
 169 Slur_engraver::acknowledge_extra_object (Grob_info info)
 170 {
 171   objects_to_acknowledge_.push_back (info);
 172 }
 173
 174 void
 175 Slur_engraver::acknowledge_script (Grob_info info)
 176 {
 177   if (!info.grob ()->internal_has_interface (ly_symbol2scm ("dynamic-interface")))
 178     acknowledge_extra_object (info);
 179 }
 180
 181 void
 182 Slur_engraver::finalize ()
 183 {
 184   for (vsize i = 0; i < slurs_.size (); i++)
 185     {
 186       slurs_[i]->warning (_f ("unterminated %s", object_name ()));
 187       slurs_[i]->suicide ();
 188     }
 189   slurs_.clear ();
 190 }
 191
 192 void
 193 Slur_engraver::create_slur (SCM spanner_id, Event_info evi, Grob *g_cause, Direction dir, bool left_broken)
 194 {
 195   Grob *ccc = left_broken
 196     ? unsmob<Grob> (get_property ("currentCommandColumn"))
 197     : 0; // efficiency
 198   SCM cause = evi.slur_ ? evi.slur_->self_scm () : g_cause->self_scm ();
 199   Spanner *slur = make_spanner (grob_symbol (), cause);
 200   slur->set_property ("spanner-id", spanner_id);
 201   if (dir)
 202     set_grob_direction (slur, dir);
 203   if (left_broken)
 204     slur->set_bound (LEFT, ccc);
 205   slurs_.push_back (slur);
 206   if (evi.note_)
 207     note_slurs_[START].insert (Note_slurs::value_type (evi.note_, slur));
 208
 209   if (double_property ())
 210   {
 211     set_grob_direction (slur, DOWN);
 212     slur = make_spanner (grob_symbol (), cause);
 213     slur->set_property ("spanner-id", spanner_id);
 214     set_grob_direction (slur, UP);
 215     if (left_broken)
 216       slur->set_bound (LEFT, ccc);
 217     slurs_.push_back (slur);
 218     if (evi.note_)
 219       note_slurs_[START].insert(Note_slurs::value_type (evi.note_, slur));
 220   }
 221
 222 }
 223
 224 bool
 225 Slur_engraver::can_create_slur (SCM id, vsize old_slurs, vsize *event_idx, Stream_event *ev)
 226 {
 227   for (vsize j = slurs_.size (); j--;)
 228     {
 229       Grob *slur = slurs_[j];
 230       Direction updown = to_dir (ev->get_property ("direction"));
 231
 232       // Check if we already have a slur with the same spanner-id.
 233       if (ly_is_equal (id, slur->get_property ("spanner-id")))
 234         {
 235           if (j < old_slurs)
 236             {
 237               // We already have an old slur, so give a warning
 238               // and completely ignore the new slur.
 239               ev->origin ()->warning (_f ("already have %s", object_name ()));
 240               if (event_idx)
 241                 start_events_.erase (start_events_.begin () + (*event_idx));
 242               return false;
 243             }
 244
 245           // If this slur event has no direction, it will not
 246           // contribute anything new to the existing slur(s), so
 247           // we can ignore it.
 248
 249           if (!updown)
 250             return false;
 251
 252           Stream_event *c = unsmob<Stream_event> (slur->get_property ("cause"));
 253
 254           if (!c)
 255             {
 256               slur->programming_error (_f ("%s without a cause", object_name ()));
 257               return true;
 258             }
 259
 260           Direction slur_dir = to_dir (c->get_property ("direction"));
 261
 262           // If the existing slur does not have a direction yet,
 263           // we'd rather take the new one.
 264
 265           if (!slur_dir)
 266             {
 267               slur->suicide ();
 268               slurs_.erase (slurs_.begin () + j);
 269               return true;
 270             }
 271
 272           // If the existing slur has the same direction as ours, drop ours
 273
 274           if (slur_dir == updown)
 275             return false;
 276         }
 277     }
 278   return true;
 279 }
 280
 281 bool
 282 Slur_engraver::try_to_end (Event_info evi)
 283 {
 284   SCM id = evi.slur_->get_property ("spanner-id");
 285
 286   // Find the slurs that are ended with this event (by checking the spanner-id)
 287   bool ended = false;
 288   for (vsize j = slurs_.size (); j--;)
 289     {
 290       if (ly_is_equal (id, slurs_[j]->get_property ("spanner-id")))
 291         {
 292           ended = true;
 293           end_slurs_.push_back (slurs_[j]);
 294           if (evi.note_)
 295             note_slurs_[STOP].insert
 296               (Note_slurs::value_type
 297                (evi.note_, dynamic_cast <Spanner *> (slurs_[j])));
 298           slurs_.erase (slurs_.begin () + j);
 299         }
 300     }
 301   return ended;
 302 }
 303
 304 void
 305 Slur_engraver::process_music ()
 306 {
 307   for (vsize i = 0; i < stop_events_.size (); i++)
 308     {
 309       SCM id = stop_events_[i].slur_->get_property ("spanner-id");
 310       bool ended = try_to_end (stop_events_[i]);
 311       if (ended)
 312         {
 313           // Ignore redundant stop events for this id
 314           for (vsize j = stop_events_.size (); --j > i;)
 315             {
 316               if (ly_is_equal (id, stop_events_[j].slur_->get_property ("spanner-id")))
 317                 stop_events_.erase (stop_events_.begin () + j);
 318             }
 319         }
 320       else
 321         stop_events_[i].slur_->origin ()->warning (_f ("cannot end %s", object_name ()));
 322     }
 323
 324   vsize old_slurs = slurs_.size ();
 325   for (vsize i = start_events_.size (); i--;)
 326     {
 327       Stream_event *ev = start_events_[i].slur_;
 328       SCM id = ev->get_property ("spanner-id");
 329       Direction updown = to_dir (ev->get_property ("direction"));
 330
 331       if (can_create_slur (id, old_slurs, &i, ev))
 332         create_slur (id, start_events_[i], 0, updown, false);
 333     }
 334
 335   set_melisma (slurs_.size ());
 336 }
 337
 338 void
 339 Slur_engraver::stop_translation_timestep ()
 340 {
 341   if (Grob *g = unsmob<Grob> (get_property ("currentCommandColumn")))
 342     {
 343       for (vsize i = 0; i < end_slurs_.size (); i++)
 344         Slur::add_extra_encompass (end_slurs_[i], g);
 345
 346       if (!start_events_.size ())
 347         for (vsize i = 0; i < slurs_.size (); i++)
 348           Slur::add_extra_encompass (slurs_[i], g);
 349     }
 350
 351   for (vsize i = 0; i < end_slurs_.size (); i++)
 352     {
 353       Spanner *s = dynamic_cast<Spanner *> (end_slurs_[i]);
 354       if (!s->get_bound (RIGHT))
 355         s->set_bound (RIGHT, unsmob<Grob> (get_property ("currentMusicalColumn")));
 356       announce_end_grob (s, SCM_EOL);
 357     }
 358
 359   for (vsize i = 0; i < objects_to_acknowledge_.size (); i++)
 360     Slur::auxiliary_acknowledge_extra_object (objects_to_acknowledge_[i], slurs_, end_slurs_);
 361
 362   note_slurs_[LEFT].clear ();
 363   note_slurs_[RIGHT].clear ();
 364   objects_to_acknowledge_.clear ();
 365   end_slurs_.clear ();
 366   start_events_.clear ();
 367   stop_events_.clear ();
 368 }