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