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   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 (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 (Slur_engraver);
  76 };
  77
  78 Slur_engraver::Slur_engraver ()
  79 {
  80 }
  81
  82 IMPLEMENT_TRANSLATOR_LISTENER (Slur_engraver, slur);
  83 void
  84 Slur_engraver::listen_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                                      "slur-event", int (d)));
  93 }
  94
  95 void
  96 Slur_engraver::set_melisma (bool m)
  97 {
  98   context ()->set_property ("slurMelismaBusy", m ? SCM_BOOL_T : SCM_BOOL_F);
  99 }
 100
 101 void
 102 Slur_engraver::acknowledge_note_column (Grob_info info)
 103 {
 104   Grob *e = info.grob ();
 105   for (vsize i = slurs_.size (); i--;)
 106     Slur::add_column (slurs_[i], e);
 107   for (vsize i = end_slurs_.size (); i--;)
 108     Slur::add_column (end_slurs_[i], e);
 109 }
 110
 111 void
 112 Slur_engraver::acknowledge_extra_object (Grob_info info)
 113 {
 114   objects_to_acknowledge_.push_back (info);
 115 }
 116
 117 void
 118 Slur_engraver::acknowledge_inline_accidental (Grob_info info)
 119 {
 120   acknowledge_extra_object (info);
 121 }
 122
 123 void
 124 Slur_engraver::acknowledge_fingering (Grob_info info)
 125 {
 126   acknowledge_extra_object (info);
 127 }
 128
 129 void
 130 Slur_engraver::acknowledge_tuplet_number (Grob_info info)
 131 {
 132   acknowledge_extra_object (info);
 133 }
 134
 135 void
 136 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 Slur_engraver::acknowledge_text_script (Grob_info info)
 144 {
 145   acknowledge_extra_object (info);
 146 }
 147
 148 void
 149 Slur_engraver::acknowledge_tie (Grob_info info)
 150 {
 151   acknowledge_extra_object (info);
 152 }
 153
 154 void
 155 Slur_engraver::finalize ()
 156 {
 157   for (vsize i = 0; i < slurs_.size (); i++)
 158     {
 159       slurs_[i]->warning (_ ("unterminated slur"));
 160       slurs_[i]->suicide ();
 161     }
 162 }
 163
 164 void
 165 Slur_engraver::process_music ()
 166 {
 167   for (vsize i = 0; i < stop_events_.size (); i++)
 168     {
 169       Stream_event *ev = stop_events_[i];
 170       string id = robust_scm2string (ev->get_property ("spanner-id"), "");
 171
 172       // Find the slur that is ended with this event (by checking the spanner-id)
 173       bool ended = false;
 174       for (vsize j = slurs_.size (); j--;)
 175         {
 176           if (id == robust_scm2string (slurs_[j]->get_property ("spanner-id"), ""))
 177             {
 178               ended = true;
 179               end_slurs_.push_back (slurs_[j]);
 180               slurs_.erase (slurs_.begin () + j);
 181             }
 182         }
 183       if (!ended)
 184         ev->origin ()->warning (_ ("cannot end slur"));
 185     }
 186
 187   for (vsize i = start_events_.size (); i--;)
 188     {
 189       Stream_event *ev = start_events_[i];
 190       string id = robust_scm2string (ev->get_property ("spanner-id"), "");
 191       bool have_slur = false;
 192       // Check if we already have a slur with the same spanner-id.
 193       // In that case, don't create a new slur, but print a warning
 194       for (vsize j = 0; j < slurs_.size (); j++)
 195         have_slur = have_slur || (id == robust_scm2string (slurs_[j]->get_property ("spanner-id"), ""));
 196
 197       if (have_slur)
 198         {
 199           // We already have a slur, so give a warning and completely ignore
 200           // the new slur.
 201           ev->origin ()->warning (_ ("already have slur"));
 202           start_events_.erase (start_events_.begin () + i);
 203         }
 204       else
 205         {
 206           Grob *slur = make_spanner ("Slur", ev->self_scm ());
 207           Direction updown = to_dir (ev->get_property ("direction"));
 208           slur->set_property ("spanner-id", ly_string2scm (id));
 209           if (updown)
 210             set_grob_direction (slur, updown);
 211           slurs_.push_back (slur);
 212
 213           if (to_boolean (get_property ("doubleSlurs")))
 214             {
 215               set_grob_direction (slur, DOWN);
 216               slur = make_spanner ("Slur", ev->self_scm ());
 217               slur->set_property ("spanner-id", ly_string2scm (id));
 218               set_grob_direction (slur, UP);
 219               slurs_.push_back (slur);
 220             }
 221         }
 222     }
 223   set_melisma (slurs_.size ());
 224 }
 225
 226 void
 227 Slur_engraver::stop_translation_timestep ()
 228 {
 229   if (Grob *g = unsmob_grob (get_property ("currentCommandColumn")))
 230     {
 231       for (vsize i = 0; i < end_slurs_.size (); i++)
 232         Slur::add_extra_encompass (end_slurs_[i], g);
 233
 234       if (!start_events_.size ())
 235         for (vsize i = 0; i < slurs_.size (); i++)
 236           Slur::add_extra_encompass (slurs_[i], g);
 237     }
 238
 239   for (vsize i = 0; i < end_slurs_.size (); i++)
 240     {
 241       Spanner *s = dynamic_cast<Spanner *> (end_slurs_[i]);
 242       if (!s->get_bound (RIGHT))
 243         s->set_bound (RIGHT, unsmob_grob (get_property ("currentMusicalColumn")));
 244       announce_end_grob (s, SCM_EOL);
 245     }
 246
 247   for (vsize i = 0; i < objects_to_acknowledge_.size (); i++)
 248     Slur::auxiliary_acknowledge_extra_object (objects_to_acknowledge_[i], slurs_, end_slurs_);
 249
 250   objects_to_acknowledge_.clear ();
 251   end_slurs_.clear ();
 252   start_events_.clear ();
 253   stop_events_.clear ();
 254 }
 255
 256 ADD_ACKNOWLEDGER (Slur_engraver, inline_accidental);
 257 ADD_ACKNOWLEDGER (Slur_engraver, fingering);
 258 ADD_ACKNOWLEDGER (Slur_engraver, note_column);
 259 ADD_ACKNOWLEDGER (Slur_engraver, script);
 260 ADD_ACKNOWLEDGER (Slur_engraver, text_script);
 261 ADD_ACKNOWLEDGER (Slur_engraver, tie);
 262 ADD_ACKNOWLEDGER (Slur_engraver, tuplet_number);
 263 ADD_TRANSLATOR (Slur_engraver,
 264                 /* doc */
 265                 "Build slur grobs from slur events.",
 266
 267                 /* create */
 268                 "Slur ",
 269
 270                 /* read */
 271                 "slurMelismaBusy "
 272                 "doubleSlurs ",
 273
 274                 /* write */
 275                 ""
 276                );