lily/slur-proto-engraver.cc

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