lily/phrasing-slur-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2012 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 "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 "spanner.hh"
  28 #include "stream-event.hh"
  29 #include "warn.hh"
  30
  31 #include "translator.icc"
  32
  33 /*
  34   NOTE NOTE NOTE
  35
  36   This is largely similar to Slur_engraver. Check if fixes
  37   apply there too.
  38
  39   (on principle, engravers don't use inheritance for code sharing)
  40
  41  */
  42
  43 /*
  44   It is possible that a slur starts and ends on the same note.  At
  45   least, it is for phrasing slurs: a note can be both beginning and
  46   ending of a phrase.
  47 */
  48 class Phrasing_slur_engraver : public Engraver
  49 {
  50   vector<Stream_event *> start_events_;
  51   vector<Stream_event *> stop_events_;
  52   vector<Grob *> slurs_;
  53   vector<Grob *> end_slurs_;
  54   vector<Grob_info> objects_to_acknowledge_;
  55
  56 protected:
  57   DECLARE_TRANSLATOR_LISTENER (phrasing_slur);
  58   DECLARE_ACKNOWLEDGER (inline_accidental);
  59   DECLARE_ACKNOWLEDGER (fingering);
  60   DECLARE_ACKNOWLEDGER (note_column);
  61   DECLARE_ACKNOWLEDGER (slur);
  62   DECLARE_ACKNOWLEDGER (script);
  63   DECLARE_ACKNOWLEDGER (dots);
  64   DECLARE_ACKNOWLEDGER (text_script);
  65   DECLARE_ACKNOWLEDGER (tie);
  66   DECLARE_ACKNOWLEDGER (tuplet_number);
  67
  68   void acknowledge_extra_object (Grob_info);
  69   void stop_translation_timestep ();
  70   void process_music ();
  71
  72   virtual void finalize ();
  73   virtual void derived_mark () const;
  74
  75 public:
  76   TRANSLATOR_DECLARATIONS (Phrasing_slur_engraver);
  77 };
  78
  79 Phrasing_slur_engraver::Phrasing_slur_engraver ()
  80 {
  81 }
  82
  83 void
  84 Phrasing_slur_engraver::derived_mark () const
  85 {
  86   for (vsize i=start_events_.size(); i--;)
  87     scm_gc_mark (start_events_[i]->self_scm ());
  88   for (vsize i=stop_events_.size(); i--;)
  89     scm_gc_mark (stop_events_[i]->self_scm ());
  90 }
  91
  92 IMPLEMENT_TRANSLATOR_LISTENER (Phrasing_slur_engraver, phrasing_slur);
  93 void
  94 Phrasing_slur_engraver::listen_phrasing_slur (Stream_event *ev)
  95 {
  96   Direction d = to_dir (ev->get_property ("span-direction"));
  97   if (d == START)
  98     start_events_.push_back (ev);
  99   else if (d == STOP)
 100     stop_events_.push_back (ev);
 101   else ev->origin ()->warning (_f ("direction of %s invalid: %d",
 102                                      "phrasing-slur-event", int (d)));
 103 }
 104
 105 void
 106 Phrasing_slur_engraver::acknowledge_note_column (Grob_info info)
 107 {
 108   Grob *e = info.grob ();
 109   for (vsize i = slurs_.size (); i--;)
 110     Slur::add_column (slurs_[i], e);
 111   for (vsize i = end_slurs_.size (); i--;)
 112     Slur::add_column (end_slurs_[i], e);
 113 }
 114
 115 void
 116 Phrasing_slur_engraver::acknowledge_extra_object (Grob_info info)
 117 {
 118   objects_to_acknowledge_.push_back (info);
 119 }
 120
 121 void
 122 Phrasing_slur_engraver::acknowledge_inline_accidental (Grob_info info)
 123 {
 124   acknowledge_extra_object (info);
 125 }
 126
 127 void
 128 Phrasing_slur_engraver::acknowledge_dots (Grob_info info)
 129 {
 130   acknowledge_extra_object (info);
 131 }
 132
 133 void
 134 Phrasing_slur_engraver::acknowledge_fingering (Grob_info info)
 135 {
 136   acknowledge_extra_object (info);
 137 }
 138
 139 void
 140 Phrasing_slur_engraver::acknowledge_tuplet_number (Grob_info info)
 141 {
 142   acknowledge_extra_object (info);
 143 }
 144
 145 void
 146 Phrasing_slur_engraver::acknowledge_script (Grob_info info)
 147 {
 148   if (!info.grob ()->internal_has_interface (ly_symbol2scm ("dynamic-interface")))
 149     acknowledge_extra_object (info);
 150 }
 151
 152 void
 153 Phrasing_slur_engraver::acknowledge_text_script (Grob_info info)
 154 {
 155   acknowledge_extra_object (info);
 156 }
 157
 158 void
 159 Phrasing_slur_engraver::acknowledge_tie (Grob_info info)
 160 {
 161   acknowledge_extra_object (info);
 162 }
 163
 164 void
 165 Phrasing_slur_engraver::acknowledge_slur (Grob_info info)
 166 {
 167   acknowledge_extra_object (info);
 168 }
 169
 170 void
 171 Phrasing_slur_engraver::finalize ()
 172 {
 173   for (vsize i = 0; i < slurs_.size (); i++)
 174     {
 175       slurs_[i]->warning (_ ("unterminated phrasing slur"));
 176       slurs_[i]->suicide ();
 177     }
 178   slurs_.clear ();
 179 }
 180
 181 void
 182 Phrasing_slur_engraver::process_music ()
 183 {
 184   for (vsize i = 0; i < stop_events_.size (); i++)
 185     {
 186       Stream_event *ev = stop_events_[i];
 187       string id = robust_scm2string (ev->get_property ("spanner-id"), "");
 188
 189       // Find the slurs that are ended with this event (by checking the spanner-id)
 190       bool ended = false;
 191       for (vsize j = slurs_.size (); j--;)
 192         {
 193           if (id == robust_scm2string (slurs_[j]->get_property ("spanner-id"), ""))
 194             {
 195               ended = true;
 196               end_slurs_.push_back (slurs_[j]);
 197               slurs_.erase (slurs_.begin () + j);
 198             }
 199         }
 200       if (ended)
 201         {
 202           // Ignore redundant stop events for this id
 203           for (vsize j = stop_events_.size (); --j > i;)
 204             {
 205               if (id == robust_scm2string (stop_events_[j]->get_property ("spanner-id"), ""))
 206                 stop_events_.erase (stop_events_.begin() + j);
 207             }
 208         }
 209       else
 210         ev->origin ()->warning (_ ("cannot end phrasing slur"));
 211     }
 212
 213   vsize old_slurs = slurs_.size ();
 214   for (vsize i = start_events_.size (); i--;)
 215     {
 216       Stream_event *ev = start_events_[i];
 217       string id = robust_scm2string (ev->get_property ("spanner-id"), "");
 218       Direction updown = to_dir (ev->get_property ("direction"));
 219
 220       bool completed;
 221       for (vsize j = slurs_.size (); !(completed = (j-- == 0));)
 222         {
 223           // Check if we already have a slur with the same spanner-id.
 224           if (id == robust_scm2string (slurs_[j]->get_property ("spanner-id"), ""))
 225             {
 226               if (j < old_slurs)
 227                 {
 228                   // We already have an old slur, so give a warning
 229                   // and completely ignore the new slur.
 230                   ev->origin ()->warning (_ ("already have phrasing slur"));
 231                   start_events_.erase (start_events_.begin () + i);
 232                   break;
 233                 }
 234
 235               // If this slur event has no direction, it will not
 236               // contribute anything new to the existing slur(s), so
 237               // we can ignore it.
 238
 239               if (!updown)
 240                 break;
 241
 242               Stream_event *c = unsmob_stream_event (slurs_[j]->get_property ("cause"));
 243
 244               if (!c) {
 245                 slurs_[j]->programming_error ("phrasing slur without a cause");
 246                 continue;
 247               }
 248
 249               Direction slur_dir = to_dir (c->get_property ("direction"));
 250
 251               // If the existing slur does not have a direction yet,
 252               // we'd rather take the new one.
 253
 254               if (!slur_dir)
 255                 {
 256                   slurs_[j]->suicide ();
 257                   slurs_.erase (slurs_.begin () + j);
 258                   continue;
 259                 }
 260
 261               // If the existing slur has the same direction as ours, drop ours
 262
 263               if (slur_dir == updown)
 264                 break;
 265             }
 266         }
 267       // If the loop completed, our slur is new
 268       if (completed)
 269         {
 270           Grob *slur = make_spanner ("PhrasingSlur", ev->self_scm ());
 271           slur->set_property ("spanner-id", ly_string2scm (id));
 272           if (updown)
 273             set_grob_direction (slur, updown);
 274           slurs_.push_back (slur);
 275         }
 276     }
 277 }
 278
 279 void
 280 Phrasing_slur_engraver::stop_translation_timestep ()
 281 {
 282   if (Grob *g = unsmob_grob (get_property ("currentCommandColumn")))
 283     {
 284       for (vsize i = 0; i < end_slurs_.size (); i++)
 285         Slur::add_extra_encompass (end_slurs_[i], g);
 286
 287       if (!start_events_.size ())
 288         for (vsize i = 0; i < slurs_.size (); i++)
 289           Slur::add_extra_encompass (slurs_[i], g);
 290     }
 291
 292   for (vsize i = 0; i < end_slurs_.size (); i++)
 293     {
 294       Spanner *s = dynamic_cast<Spanner *> (end_slurs_[i]);
 295       if (!s->get_bound (RIGHT))
 296         s->set_bound (RIGHT, unsmob_grob (get_property ("currentMusicalColumn")));
 297       announce_end_grob (s, SCM_EOL);
 298     }
 299
 300   for (vsize i = 0; i < objects_to_acknowledge_.size (); i++)
 301     Slur::auxiliary_acknowledge_extra_object (objects_to_acknowledge_[i], slurs_, end_slurs_);
 302
 303   objects_to_acknowledge_.clear ();
 304   end_slurs_.clear ();
 305   start_events_.clear ();
 306   stop_events_.clear ();
 307 }
 308
 309 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, inline_accidental);
 310 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, fingering)
 311 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, note_column);
 312 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, slur);
 313 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, script);
 314 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, dots);
 315 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, text_script);
 316 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, tie);
 317 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, tuplet_number);
 318
 319 ADD_TRANSLATOR (Phrasing_slur_engraver,
 320                 /* doc */
 321                 "Print phrasing slurs.  Similar to @ref{Slur_engraver}.",
 322
 323                 /* create */
 324                 "PhrasingSlur ",
 325
 326                 /* read */
 327                 "",
 328
 329                 /* write */
 330                 ""
 331                );