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
  74 public:
  75   TRANSLATOR_DECLARATIONS (Phrasing_slur_engraver);
  76 };
  77
  78 Phrasing_slur_engraver::Phrasing_slur_engraver ()
  79 {
  80 }
  81
  82 IMPLEMENT_TRANSLATOR_LISTENER (Phrasing_slur_engraver, phrasing_slur);
  83 void
  84 Phrasing_slur_engraver::listen_phrasing_slur (Stream_event *ev)
  85 {
  86   Direction d = to_dir (ev->get_property ("span-direction"));
  87   if (d == START)
  88     start_events_.push_back (ev);
  89   else if (d == STOP)
  90     stop_events_.push_back (ev);
  91   else ev->origin ()->warning (_f ("direction of %s invalid: %d",
  92                                      "phrasing-slur-event", int (d)));
  93 }
  94
  95 void
  96 Phrasing_slur_engraver::acknowledge_note_column (Grob_info info)
  97 {
  98   Grob *e = info.grob ();
  99   for (vsize i = slurs_.size (); i--;)
 100     Slur::add_column (slurs_[i], e);
 101   for (vsize i = end_slurs_.size (); i--;)
 102     Slur::add_column (end_slurs_[i], e);
 103 }
 104
 105 void
 106 Phrasing_slur_engraver::acknowledge_extra_object (Grob_info info)
 107 {
 108   objects_to_acknowledge_.push_back (info);
 109 }
 110
 111 void
 112 Phrasing_slur_engraver::acknowledge_inline_accidental (Grob_info info)
 113 {
 114   acknowledge_extra_object (info);
 115 }
 116
 117 void
 118 Phrasing_slur_engraver::acknowledge_dots (Grob_info info)
 119 {
 120   acknowledge_extra_object (info);
 121 }
 122
 123 void
 124 Phrasing_slur_engraver::acknowledge_fingering (Grob_info info)
 125 {
 126   acknowledge_extra_object (info);
 127 }
 128
 129 void
 130 Phrasing_slur_engraver::acknowledge_tuplet_number (Grob_info info)
 131 {
 132   acknowledge_extra_object (info);
 133 }
 134
 135 void
 136 Phrasing_slur_engraver::acknowledge_script (Grob_info info)
 137 {
 138   if (!info.grob ()->internal_has_interface (ly_symbol2scm ("dynamic-interface")))
 139     acknowledge_extra_object (info);
 140 }
 141
 142 void
 143 Phrasing_slur_engraver::acknowledge_text_script (Grob_info info)
 144 {
 145   acknowledge_extra_object (info);
 146 }
 147
 148 void
 149 Phrasing_slur_engraver::acknowledge_tie (Grob_info info)
 150 {
 151   acknowledge_extra_object (info);
 152 }
 153
 154 void
 155 Phrasing_slur_engraver::acknowledge_slur (Grob_info info)
 156 {
 157   acknowledge_extra_object (info);
 158 }
 159
 160 void
 161 Phrasing_slur_engraver::finalize ()
 162 {
 163   for (vsize i = 0; i < slurs_.size (); i++)
 164     {
 165       slurs_[i]->warning (_ ("unterminated phrasing slur"));
 166       slurs_[i]->suicide ();
 167     }
 168 }
 169
 170 void
 171 Phrasing_slur_engraver::process_music ()
 172 {
 173   for (vsize i = 0; i < stop_events_.size (); i++)
 174     {
 175       Stream_event *ev = stop_events_[i];
 176       string id = robust_scm2string (ev->get_property ("spanner-id"), "");
 177
 178       // Find the slurs that are ended with this event (by checking the spanner-id)
 179       bool ended = false;
 180       for (vsize j = slurs_.size (); j--;)
 181         {
 182           if (id == robust_scm2string (slurs_[j]->get_property ("spanner-id"), ""))
 183             {
 184               ended = true;
 185               end_slurs_.push_back (slurs_[j]);
 186               slurs_.erase (slurs_.begin () + j);
 187             }
 188         }
 189       if (ended)
 190         {
 191           // Ignore redundant stop events for this id
 192           for (vsize j = stop_events_.size (); --j > i;)
 193             {
 194               if (id == robust_scm2string (stop_events_[j]->get_property ("spanner-id"), ""))
 195                 stop_events_.erase (stop_events_.begin() + j);
 196             }
 197         }
 198       else
 199         ev->origin ()->warning (_ ("cannot end phrasing slur"));
 200     }
 201
 202   vsize old_slurs = slurs_.size ();
 203   for (vsize i = start_events_.size (); i--;)
 204     {
 205       Stream_event *ev = start_events_[i];
 206       string id = robust_scm2string (ev->get_property ("spanner-id"), "");
 207       Direction updown = to_dir (ev->get_property ("direction"));
 208
 209       bool completed;
 210       for (vsize j = 0; !(completed = (j == slurs_.size ())); j++)
 211         {
 212           // Check if we already have a slur with the same spanner-id.
 213           if (id == robust_scm2string (slurs_[j]->get_property ("spanner-id"), ""))
 214             {
 215               if (j < old_slurs)
 216                 {
 217                   // We already have an old slur, so give a warning
 218                   // and completely ignore the new slur.
 219                   ev->origin ()->warning (_ ("already have phrasing slur"));
 220                   start_events_.erase (start_events_.begin () + i);
 221                   break;
 222                 }
 223
 224               // If this slur event has no direction, it will not
 225               // contribute anything new to the existing slur(s), so
 226               // we can ignore it.  This is not entirely accurate:
 227               // tweaks or context properties like those set with
 228               // \slurUp can still override a neutral direction, so
 229               // when encountering a slur event with "opposite"
 230               // direction first, then one with neutral direction, we
 231               // only let the "opposite" direction remain, while if
 232               // the order is the other way round, a double slur
 233               // results since the direction of the first slur is no
 234               // longer attributable to a "neutral" slur event.  A
 235               // mixture of neutral and directed events is nothing
 236               // that the partcombiner should crank out, and it would
 237               // be decidedly strange for manual input.
 238
 239               if (!updown)
 240                 break;
 241
 242               // If the existing slur does not have a direction yet,
 243               // give it ours
 244
 245               Direction slur_dir = to_dir (slurs_[j]->get_property ("direction"));
 246
 247               if (!slur_dir)
 248                 {
 249                   set_grob_direction (slurs_[j], updown);
 250                   break;
 251                 }
 252
 253               // If the existing slur has the same direction as ours, drop ours
 254
 255               if (slur_dir == updown)
 256                 break;
 257             }
 258         }
 259       // If the loop completed, our slur is new
 260       if (completed)
 261         {
 262           Grob *slur = make_spanner ("PhrasingSlur", ev->self_scm ());
 263           slur->set_property ("spanner-id", ly_string2scm (id));
 264           if (updown)
 265             set_grob_direction (slur, updown);
 266           slurs_.push_back (slur);
 267         }
 268     }
 269 }
 270
 271 void
 272 Phrasing_slur_engraver::stop_translation_timestep ()
 273 {
 274   for (vsize i = 0; i < objects_to_acknowledge_.size (); i++)
 275     Slur::auxiliary_acknowledge_extra_object (objects_to_acknowledge_[i], slurs_, end_slurs_);
 276
 277   end_slurs_.clear ();
 278   start_events_.clear ();
 279   stop_events_.clear ();
 280   objects_to_acknowledge_.clear ();
 281 }
 282
 283 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, inline_accidental);
 284 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, fingering)
 285 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, note_column);
 286 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, slur);
 287 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, script);
 288 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, dots);
 289 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, text_script);
 290 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, tie);
 291 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, tuplet_number);
 292
 293 ADD_TRANSLATOR (Phrasing_slur_engraver,
 294                 /* doc */
 295                 "Print phrasing slurs.  Similar to @ref{Slur_engraver}.",
 296
 297                 /* create */
 298                 "PhrasingSlur ",
 299
 300                 /* read */
 301                 "",
 302
 303                 /* write */
 304                 ""
 305                );