lily/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 Phrasing_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 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   void set_melisma (bool);
  57
  58 protected:
  59   DECLARE_TRANSLATOR_LISTENER (slur);
  60   DECLARE_ACKNOWLEDGER (inline_accidental);
  61   DECLARE_ACKNOWLEDGER (fingering);
  62   DECLARE_ACKNOWLEDGER (note_column);
  63   DECLARE_ACKNOWLEDGER (script);
  64   DECLARE_ACKNOWLEDGER (dots);
  65   DECLARE_ACKNOWLEDGER (text_script);
  66   DECLARE_ACKNOWLEDGER (tie);
  67   DECLARE_ACKNOWLEDGER (tuplet_number);
  68
  69   void acknowledge_extra_object (Grob_info);
  70   void stop_translation_timestep ();
  71   void process_music ();
  72
  73   virtual void finalize ();
  74
  75 public:
  76   TRANSLATOR_DECLARATIONS (Slur_engraver);
  77 };
  78
  79 Slur_engraver::Slur_engraver ()
  80 {
  81 }
  82
  83 IMPLEMENT_TRANSLATOR_LISTENER (Slur_engraver, slur);
  84 void
  85 Slur_engraver::listen_slur (Stream_event *ev)
  86 {
  87   Direction d = to_dir (ev->get_property ("span-direction"));
  88   if (d == START)
  89     start_events_.push_back (ev);
  90   else if (d == STOP)
  91     stop_events_.push_back (ev);
  92   else ev->origin ()->warning (_f ("direction of %s invalid: %d",
  93                                      "slur-event", int (d)));
  94 }
  95
  96 void
  97 Slur_engraver::set_melisma (bool m)
  98 {
  99   context ()->set_property ("slurMelismaBusy", m ? SCM_BOOL_T : SCM_BOOL_F);
 100 }
 101
 102 void
 103 Slur_engraver::acknowledge_note_column (Grob_info info)
 104 {
 105   Grob *e = info.grob ();
 106   for (vsize i = slurs_.size (); i--;)
 107     Slur::add_column (slurs_[i], e);
 108   for (vsize i = end_slurs_.size (); i--;)
 109     Slur::add_column (end_slurs_[i], e);
 110 }
 111
 112 void
 113 Slur_engraver::acknowledge_extra_object (Grob_info info)
 114 {
 115   objects_to_acknowledge_.push_back (info);
 116 }
 117
 118 void
 119 Slur_engraver::acknowledge_inline_accidental (Grob_info info)
 120 {
 121   acknowledge_extra_object (info);
 122 }
 123
 124 void
 125 Slur_engraver::acknowledge_dots (Grob_info info)
 126 {
 127   acknowledge_extra_object (info);
 128 }
 129
 130 void
 131 Slur_engraver::acknowledge_fingering (Grob_info info)
 132 {
 133   acknowledge_extra_object (info);
 134 }
 135
 136 void
 137 Slur_engraver::acknowledge_tuplet_number (Grob_info info)
 138 {
 139   acknowledge_extra_object (info);
 140 }
 141
 142 void
 143 Slur_engraver::acknowledge_script (Grob_info info)
 144 {
 145   if (!info.grob ()->internal_has_interface (ly_symbol2scm ("dynamic-interface")))
 146     acknowledge_extra_object (info);
 147 }
 148
 149 void
 150 Slur_engraver::acknowledge_text_script (Grob_info info)
 151 {
 152   acknowledge_extra_object (info);
 153 }
 154
 155 void
 156 Slur_engraver::acknowledge_tie (Grob_info info)
 157 {
 158   acknowledge_extra_object (info);
 159 }
 160
 161 void
 162 Slur_engraver::finalize ()
 163 {
 164   for (vsize i = 0; i < slurs_.size (); i++)
 165     {
 166       slurs_[i]->warning (_ ("unterminated slur"));
 167       slurs_[i]->suicide ();
 168     }
 169 }
 170
 171 void
 172 Slur_engraver::process_music ()
 173 {
 174   for (vsize i = 0; i < stop_events_.size (); i++)
 175     {
 176       Stream_event *ev = stop_events_[i];
 177       string id = robust_scm2string (ev->get_property ("spanner-id"), "");
 178
 179       // Find the slur that is ended with this event (by checking the spanner-id)
 180       bool ended = false;
 181       SCM starter = SCM_BOOL_F;
 182       for (vsize j = slurs_.size (); j--;)
 183         {
 184           if (id == robust_scm2string (slurs_[j]->get_property ("spanner-id"), ""))
 185             {
 186               // We end only one slur unless several ones have been
 187               // caused by the same event, like with double slurs.
 188               if (!ended || scm_is_eq (starter,
 189                                        slurs_[j]->get_property ("cause")))
 190                 {
 191                   ended = true;
 192                   starter = slurs_[j]->get_property ("cause");
 193                   end_slurs_.push_back (slurs_[j]);
 194                   slurs_.erase (slurs_.begin () + j);
 195                 }
 196             }
 197         }
 198       if (!ended)
 199         ev->origin ()->warning (_ ("cannot end slur"));
 200     }
 201
 202   for (vsize i = start_events_.size (); i--;)
 203     {
 204       Stream_event *ev = start_events_[i];
 205       string id = robust_scm2string (ev->get_property ("spanner-id"), "");
 206       bool have_slur = false;
 207       // Check if we already have a slur with the same spanner-id.
 208       // In that case, don't create a new slur, but print a warning
 209       for (vsize j = 0; j < slurs_.size (); j++)
 210         have_slur = have_slur || (id == robust_scm2string (slurs_[j]->get_property ("spanner-id"), ""));
 211
 212       if (have_slur)
 213         {
 214           // We already have a slur, so give a warning and completely ignore
 215           // the new slur.
 216           ev->origin ()->warning (_ ("already have slur"));
 217           start_events_.erase (start_events_.begin () + i);
 218         }
 219     }
 220   for (vsize i = start_events_.size (); i--;)
 221     {
 222       Stream_event *ev = start_events_[i];
 223       string id = robust_scm2string (ev->get_property ("spanner-id"), "");
 224
 225       Grob *slur = make_spanner ("Slur", ev->self_scm ());
 226       Direction updown = to_dir (ev->get_property ("direction"));
 227       slur->set_property ("spanner-id", ly_string2scm (id));
 228       if (updown)
 229         set_grob_direction (slur, updown);
 230       slurs_.push_back (slur);
 231
 232       if (to_boolean (get_property ("doubleSlurs")))
 233         {
 234           set_grob_direction (slur, DOWN);
 235           slur = make_spanner ("Slur", ev->self_scm ());
 236           slur->set_property ("spanner-id", ly_string2scm (id));
 237           set_grob_direction (slur, UP);
 238           slurs_.push_back (slur);
 239         }
 240     }
 241   set_melisma (slurs_.size ());
 242 }
 243
 244 void
 245 Slur_engraver::stop_translation_timestep ()
 246 {
 247   if (Grob *g = unsmob_grob (get_property ("currentCommandColumn")))
 248     {
 249       for (vsize i = 0; i < end_slurs_.size (); i++)
 250         Slur::add_extra_encompass (end_slurs_[i], g);
 251
 252       if (!start_events_.size ())
 253         for (vsize i = 0; i < slurs_.size (); i++)
 254           Slur::add_extra_encompass (slurs_[i], g);
 255     }
 256
 257   for (vsize i = 0; i < end_slurs_.size (); i++)
 258     {
 259       Spanner *s = dynamic_cast<Spanner *> (end_slurs_[i]);
 260       if (!s->get_bound (RIGHT))
 261         s->set_bound (RIGHT, unsmob_grob (get_property ("currentMusicalColumn")));
 262       announce_end_grob (s, SCM_EOL);
 263     }
 264
 265   for (vsize i = 0; i < objects_to_acknowledge_.size (); i++)
 266     Slur::auxiliary_acknowledge_extra_object (objects_to_acknowledge_[i], slurs_, end_slurs_);
 267
 268   objects_to_acknowledge_.clear ();
 269   end_slurs_.clear ();
 270   start_events_.clear ();
 271   stop_events_.clear ();
 272 }
 273
 274 ADD_ACKNOWLEDGER (Slur_engraver, inline_accidental);
 275 ADD_ACKNOWLEDGER (Slur_engraver, fingering);
 276 ADD_ACKNOWLEDGER (Slur_engraver, note_column);
 277 ADD_ACKNOWLEDGER (Slur_engraver, script);
 278 ADD_ACKNOWLEDGER (Slur_engraver, text_script);
 279 ADD_ACKNOWLEDGER (Slur_engraver, dots);
 280 ADD_ACKNOWLEDGER (Slur_engraver, tie);
 281 ADD_ACKNOWLEDGER (Slur_engraver, tuplet_number);
 282 ADD_TRANSLATOR (Slur_engraver,
 283                 /* doc */
 284                 "Build slur grobs from slur events.",
 285
 286                 /* create */
 287                 "Slur ",
 288
 289                 /* read */
 290                 "slurMelismaBusy "
 291                 "doubleSlurs ",
 292
 293                 /* write */
 294                 ""
 295                );