lily/slur-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2011 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 /*
  35   NOTE NOTE NOTE
  36
  37   This is largely similar to Phrasing_slur_engraver. Check if fixes
  38   apply there too.
  39
  40   (on principle, engravers don't use inheritance for code sharing)
  41
  42  */
  43
  44 /*
  45   It is possible that a slur starts and ends on the same note.  At
  46   least, it is for phrasing slurs: a note can be both beginning and
  47   ending of a phrase.
  48 */
  49 class Slur_engraver : public Engraver
  50 {
  51   vector<Stream_event *> start_events_;
  52   vector<Stream_event *> stop_events_;
  53   vector<Grob*> slurs_;
  54   vector<Grob*> end_slurs_;
  55
  56   void set_melisma (bool);
  57
  58 protected:
  59   DECLARE_TRANSLATOR_LISTENER (slur);
  60   DECLARE_ACKNOWLEDGER (accidental);
  61   DECLARE_ACKNOWLEDGER (fingering);
  62   DECLARE_ACKNOWLEDGER (note_column);
  63   DECLARE_ACKNOWLEDGER (script);
  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
  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   Slur::auxiliary_acknowledge_extra_object (info, slurs_, end_slurs_);
 116 }
 117
 118 void
 119 Slur_engraver::acknowledge_accidental (Grob_info info)
 120 {
 121   acknowledge_extra_object (info);
 122 }
 123
 124 void
 125 Slur_engraver::acknowledge_fingering (Grob_info info)
 126 {
 127   acknowledge_extra_object (info);
 128 }
 129
 130 void
 131 Slur_engraver::acknowledge_tuplet_number (Grob_info info)
 132 {
 133   acknowledge_extra_object (info);
 134 }
 135
 136 void
 137 Slur_engraver::acknowledge_script (Grob_info info)
 138 {
 139   if (!info.grob ()->internal_has_interface (ly_symbol2scm ("dynamic-interface")))
 140     acknowledge_extra_object (info);
 141 }
 142
 143 void
 144 Slur_engraver::acknowledge_text_script (Grob_info info)
 145 {
 146   acknowledge_extra_object (info);
 147 }
 148
 149 void
 150 Slur_engraver::acknowledge_tie (Grob_info info)
 151 {
 152   acknowledge_extra_object (info);
 153 }
 154
 155 void
 156 Slur_engraver::finalize ()
 157 {
 158   for (vsize i = 0; i < slurs_.size (); i++)
 159     {
 160       slurs_[i]->warning (_ ("unterminated slur"));
 161       slurs_[i]->suicide ();
 162     }
 163 }
 164
 165 void
 166 Slur_engraver::process_music ()
 167 {
 168   for (vsize i = 0; i < stop_events_.size (); i++)
 169     {
 170       Stream_event *ev = stop_events_[i];
 171       string id = robust_scm2string (ev->get_property ("spanner-id"), "");
 172
 173       // Find the slur that is ended with this event (by checking the spanner-id)
 174       bool ended = false;
 175       for (vsize j = slurs_.size (); j--;)
 176         {
 177           if (id == robust_scm2string (slurs_[j]->get_property ("spanner-id"), ""))
 178             {
 179               ended = true;
 180               end_slurs_.push_back (slurs_[j]);
 181               slurs_.erase (slurs_.begin () + j);
 182             }
 183         }
 184       if (!ended)
 185         ev->origin ()->warning (_ ("cannot end slur"));
 186     }
 187
 188   for (vsize i = start_events_.size (); i--;)
 189     {
 190       Stream_event *ev = start_events_[i];
 191       string id = robust_scm2string (ev->get_property ("spanner-id"), "");
 192       bool have_slur = false;
 193       // Check if we already have a slur with the same spanner-id.
 194       // In that case, don't create a new slur, but print a warning
 195       for (vsize j = 0; j < slurs_.size (); j++)
 196           have_slur = have_slur || (id == robust_scm2string (slurs_[j]->get_property ("spanner-id"), ""));
 197
 198       if (have_slur)
 199         {
 200           // We already have a slur, so give a warning and completely ignore
 201           // the new slur.
 202           ev->origin ()->warning(_ ("already have slur"));
 203           start_events_.erase (start_events_.begin () + i);
 204         }
 205       else
 206         {
 207           Grob *slur = make_spanner ("Slur", ev->self_scm ());
 208           Direction updown = to_dir (ev->get_property ("direction"));
 209           slur->set_property ("spanner-id", ly_string2scm (id));
 210           if (updown)
 211             set_grob_direction (slur, updown);
 212           slurs_.push_back (slur);
 213
 214           if (to_boolean (get_property ("doubleSlurs")))
 215             {
 216               set_grob_direction (slur, DOWN);
 217               slur = make_spanner ("Slur", ev->self_scm ());
 218               slur->set_property ("spanner-id", ly_string2scm (id));
 219               set_grob_direction (slur, UP);
 220               slurs_.push_back (slur);
 221             }
 222         }
 223     }
 224   set_melisma (slurs_.size ());
 225 }
 226
 227 void
 228 Slur_engraver::stop_translation_timestep ()
 229 {
 230   if (Grob *g = unsmob_grob (get_property ("currentCommandColumn")))
 231     {
 232       for (vsize i = 0; i < end_slurs_.size (); i++)
 233         Slur::add_extra_encompass (end_slurs_[i], g);
 234
 235       if (!start_events_.size ())
 236         for (vsize i = 0; i < slurs_.size (); i++)
 237           Slur::add_extra_encompass (slurs_[i], g);
 238     }
 239
 240
 241   for (vsize i = 0; i < end_slurs_.size (); i++)
 242     {
 243       Spanner * s = dynamic_cast<Spanner*> (end_slurs_[i]);
 244       if (!s->get_bound (RIGHT))
 245         s->set_bound (RIGHT, unsmob_grob (get_property ("currentMusicalColumn")));
 246       announce_end_grob (s, SCM_EOL);
 247     }
 248   end_slurs_.clear ();
 249   start_events_.clear ();
 250   stop_events_.clear ();
 251 }
 252
 253 ADD_ACKNOWLEDGER (Slur_engraver, accidental);
 254 ADD_ACKNOWLEDGER (Slur_engraver, fingering);
 255 ADD_ACKNOWLEDGER (Slur_engraver, note_column);
 256 ADD_ACKNOWLEDGER (Slur_engraver, script);
 257 ADD_ACKNOWLEDGER (Slur_engraver, text_script);
 258 ADD_ACKNOWLEDGER (Slur_engraver, tie);
 259 ADD_ACKNOWLEDGER (Slur_engraver, tuplet_number);
 260 ADD_TRANSLATOR (Slur_engraver,
 261                 /* doc */
 262                 "Build slur grobs from slur events.",
 263
 264                 /* create */
 265                 "Slur ",
 266
 267                 /* read */
 268                 "slurMelismaBusy "
 269                 "doubleSlurs ",
 270
 271                 /* write */
 272                 ""
 273                 );