lily/slur-proto-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2013--2015 Mike Solomon <mike@mikesolomon.org>
   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 "engraver.hh"
  21
  22 #include "context.hh"
  23 #include "directional-element-interface.hh"
  24 #include "international.hh"
  25 #include "note-column.hh"
  26 #include "pointer-group-interface.hh"
  27 #include "slur.hh"
  28 #include "slur-proto-engraver.hh"
  29 #include "spanner.hh"
  30 #include "stream-event.hh"
  31 #include "warn.hh"
  32
  33 #include "translator.icc"
  34
  35 void
  36 Slur_proto_engraver::derived_mark () const
  37 {
  38   for (vsize i = start_events_.size (); i--;)
  39     {
  40       scm_gc_mark (start_events_[i].slur_->self_scm ());
  41       scm_gc_mark (start_events_[i].note_->self_scm ());
  42     }
  43   for (vsize i = stop_events_.size (); i--;)
  44     {
  45       scm_gc_mark (stop_events_[i].slur_->self_scm ());
  46       scm_gc_mark (stop_events_[i].note_->self_scm ());
  47     }
  48 }
  49
  50 void
  51 Slur_proto_engraver::listen_slur (Stream_event *ev, Stream_event *note)
  52 {
  53   Direction d = to_dir (ev->get_property ("span-direction"));
  54   if (d == START)
  55     start_events_.push_back (Event_info (ev, note));
  56   else if (d == STOP)
  57     stop_events_.push_back (Event_info (ev, note));
  58   else ev->origin ()->warning (_f ("direction of %s invalid: %d",
  59                                      event_name_, int (d)));
  60 }
  61
  62 void
  63 Slur_proto_engraver::listen_note (Stream_event *ev)
  64 {
  65   for (SCM arts = ev->get_property ("articulations");
  66        scm_is_pair (arts); arts = scm_cdr (arts))
  67     {
  68       Stream_event *art = unsmob<Stream_event> (scm_car (arts));
  69       if (art->in_event_class (event_symbol ()))
  70         listen_slur (art, ev);
  71     }
  72 }
  73
  74 void
  75 Slur_proto_engraver::acknowledge_note_column (Grob_info info)
  76 {
  77   Grob *e = info.grob ();
  78   for (vsize i = slurs_.size (); i--;)
  79     Slur::add_column (slurs_[i], e);
  80   for (vsize i = end_slurs_.size (); i--;)
  81     Slur::add_column (end_slurs_[i], e);
  82   // Now cater for slurs starting/ending at a notehead: those override
  83   // the column bounds
  84   if (note_slurs_[START].empty () && note_slurs_[STOP].empty ())
  85     return;
  86   extract_grob_set (e, "note-heads", heads);
  87   for (vsize i = heads.size (); i--;)
  88     {
  89       if (Stream_event *ev =
  90           unsmob<Stream_event> (heads[i]->get_property ("cause")))
  91         for (LEFT_and_RIGHT (d))
  92           {
  93             std::pair<Note_slurs::const_iterator, Note_slurs::const_iterator> its
  94               = note_slurs_[d].equal_range (ev);
  95             for (Note_slurs::const_iterator it = its.first;
  96                  it != its.second;
  97                  ++it)
  98               it->second->set_bound (d, heads[i]);
  99           }
 100     }
 101 }
 102
 103 void
 104 Slur_proto_engraver::acknowledge_extra_object (Grob_info info)
 105 {
 106   objects_to_acknowledge_.push_back (info);
 107 }
 108
 109 void
 110 Slur_proto_engraver::acknowledge_inline_accidental (Grob_info info)
 111 {
 112   acknowledge_extra_object (info);
 113 }
 114
 115 void
 116 Slur_proto_engraver::acknowledge_dots (Grob_info info)
 117 {
 118   acknowledge_extra_object (info);
 119 }
 120
 121 void
 122 Slur_proto_engraver::acknowledge_fingering (Grob_info info)
 123 {
 124   acknowledge_extra_object (info);
 125 }
 126
 127 void
 128 Slur_proto_engraver::acknowledge_tuplet_number (Grob_info info)
 129 {
 130   acknowledge_extra_object (info);
 131 }
 132
 133 void
 134 Slur_proto_engraver::acknowledge_script (Grob_info info)
 135 {
 136   if (!info.grob ()->internal_has_interface (ly_symbol2scm ("dynamic-interface")))
 137     acknowledge_extra_object (info);
 138 }
 139
 140 void
 141 Slur_proto_engraver::acknowledge_text_script (Grob_info info)
 142 {
 143   acknowledge_extra_object (info);
 144 }
 145
 146 void
 147 Slur_proto_engraver::acknowledge_end_tie (Grob_info info)
 148 {
 149   acknowledge_extra_object (info);
 150 }
 151
 152 void
 153 Slur_proto_engraver::finalize ()
 154 {
 155   for (vsize i = 0; i < slurs_.size (); i++)
 156     {
 157       slurs_[i]->warning (_f ("unterminated %s", object_name_));
 158       slurs_[i]->suicide ();
 159     }
 160   slurs_.clear ();
 161 }
 162
 163 void
 164 Slur_proto_engraver::create_slur (const string &spanner_id, Event_info evi, Grob *g_cause, Direction dir, bool left_broken)
 165 {
 166   Grob *ccc = left_broken
 167     ? unsmob<Grob> (get_property ("currentCommandColumn"))
 168     : 0; // efficiency
 169   SCM cause = evi.slur_ ? evi.slur_->self_scm () : g_cause->self_scm ();
 170   Spanner *slur = make_spanner (grob_name_, cause);
 171   slur->set_property ("spanner-id", ly_string2scm (spanner_id));
 172   if (dir)
 173     set_grob_direction (slur, dir);
 174   if (left_broken)
 175     slur->set_bound (LEFT, ccc);
 176   slurs_.push_back (slur);
 177   if (evi.note_)
 178     note_slurs_[START].insert (Note_slurs::value_type (evi.note_, slur));
 179
 180   if (double_property_name_
 181       && to_boolean (get_property (double_property_name_)))
 182   {
 183     set_grob_direction (slur, DOWN);
 184     slur = make_spanner (grob_name_, cause);
 185     slur->set_property ("spanner-id", ly_string2scm (spanner_id));
 186     set_grob_direction (slur, UP);
 187     if (left_broken)
 188       slur->set_bound (LEFT, ccc);
 189     slurs_.push_back (slur);
 190     if (evi.note_)
 191       note_slurs_[START].insert(Note_slurs::value_type (evi.note_, slur));
 192   }
 193
 194 }
 195
 196 bool
 197 Slur_proto_engraver::can_create_slur (const string &id, vsize old_slurs, vsize *event_idx, Stream_event *ev)
 198 {
 199   for (vsize j = slurs_.size (); j--;)
 200     {
 201       Grob *slur = slurs_[j];
 202       Direction updown = to_dir (ev->get_property ("direction"));
 203
 204       // Check if we already have a slur with the same spanner-id.
 205       if (id == robust_scm2string (slur->get_property ("spanner-id"), ""))
 206         {
 207           if (j < old_slurs)
 208             {
 209               // We already have an old slur, so give a warning
 210               // and completely ignore the new slur.
 211               ev->origin ()->warning (_f ("already have %s", object_name_));
 212               if (event_idx)
 213                 start_events_.erase (start_events_.begin () + (*event_idx));
 214               return false;
 215             }
 216
 217           // If this slur event has no direction, it will not
 218           // contribute anything new to the existing slur(s), so
 219           // we can ignore it.
 220
 221           if (!updown)
 222             return false;
 223
 224           Stream_event *c = unsmob<Stream_event> (slur->get_property ("cause"));
 225
 226           if (!c)
 227             {
 228               slur->programming_error (_f ("%s without a cause", object_name_));
 229               return true;
 230             }
 231
 232           Direction slur_dir = to_dir (c->get_property ("direction"));
 233
 234           // If the existing slur does not have a direction yet,
 235           // we'd rather take the new one.
 236
 237           if (!slur_dir)
 238             {
 239               slur->suicide ();
 240               slurs_.erase (slurs_.begin () + j);
 241               return true;
 242             }
 243
 244           // If the existing slur has the same direction as ours, drop ours
 245
 246           if (slur_dir == updown)
 247             return false;
 248         }
 249     }
 250   return true;
 251 }
 252
 253 bool
 254 Slur_proto_engraver::try_to_end (Event_info evi)
 255 {
 256   string id = robust_scm2string (evi.slur_->get_property ("spanner-id"), "");
 257
 258   // Find the slurs that are ended with this event (by checking the spanner-id)
 259   bool ended = false;
 260   for (vsize j = slurs_.size (); j--;)
 261     {
 262       if (id == robust_scm2string (slurs_[j]->get_property ("spanner-id"), ""))
 263         {
 264           ended = true;
 265           end_slurs_.push_back (slurs_[j]);
 266           if (evi.note_)
 267             note_slurs_[STOP].insert
 268               (Note_slurs::value_type
 269                (evi.note_, dynamic_cast <Spanner *> (slurs_[j])));
 270           slurs_.erase (slurs_.begin () + j);
 271         }
 272     }
 273   return ended;
 274 }
 275
 276 void
 277 Slur_proto_engraver::process_music ()
 278 {
 279   for (vsize i = 0; i < stop_events_.size (); i++)
 280     {
 281       string id = robust_scm2string
 282         (stop_events_[i].slur_->get_property ("spanner-id"), "");
 283       bool ended = try_to_end (stop_events_[i]);
 284       if (ended)
 285         {
 286           // Ignore redundant stop events for this id
 287           for (vsize j = stop_events_.size (); --j > i;)
 288             {
 289               if (id == robust_scm2string
 290                   (stop_events_[j].slur_->get_property ("spanner-id"), ""))
 291                 stop_events_.erase (stop_events_.begin () + j);
 292             }
 293         }
 294       else
 295         stop_events_[i].slur_->origin ()->warning (_f ("cannot end %s", object_name_));
 296     }
 297
 298   vsize old_slurs = slurs_.size ();
 299   for (vsize i = start_events_.size (); i--;)
 300     {
 301       Stream_event *ev = start_events_[i].slur_;
 302       string id = robust_scm2string (ev->get_property ("spanner-id"), "");
 303       Direction updown = to_dir (ev->get_property ("direction"));
 304
 305       if (can_create_slur (id, old_slurs, &i, ev))
 306         create_slur (id, start_events_[i], 0, updown, false);
 307     }
 308
 309   set_melisma (slurs_.size ());
 310 }
 311
 312 void
 313 Slur_proto_engraver::set_melisma (bool)
 314 {
 315 }
 316
 317 void
 318 Slur_proto_engraver::stop_translation_timestep ()
 319 {
 320   if (Grob *g = unsmob<Grob> (get_property ("currentCommandColumn")))
 321     {
 322       for (vsize i = 0; i < end_slurs_.size (); i++)
 323         Slur::add_extra_encompass (end_slurs_[i], g);
 324
 325       if (!start_events_.size ())
 326         for (vsize i = 0; i < slurs_.size (); i++)
 327           Slur::add_extra_encompass (slurs_[i], g);
 328     }
 329
 330   for (vsize i = 0; i < end_slurs_.size (); i++)
 331     {
 332       Spanner *s = dynamic_cast<Spanner *> (end_slurs_[i]);
 333       if (!s->get_bound (RIGHT))
 334         s->set_bound (RIGHT, unsmob<Grob> (get_property ("currentMusicalColumn")));
 335       announce_end_grob (s, SCM_EOL);
 336     }
 337
 338   for (vsize i = 0; i < objects_to_acknowledge_.size (); i++)
 339     Slur::auxiliary_acknowledge_extra_object (objects_to_acknowledge_[i], slurs_, end_slurs_);
 340
 341   note_slurs_[LEFT].clear ();
 342   note_slurs_[RIGHT].clear ();
 343   objects_to_acknowledge_.clear ();
 344   end_slurs_.clear ();
 345   start_events_.clear ();
 346   stop_events_.clear ();
 347 }
 348
 349 // no ADD_ACKNOWLEDGER / ADD_TRANSLATOR macro calls
 350 // since this class is abstract