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