lily/slur-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2010 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   Drul_array<Stream_event *> events_;
  52   Stream_event *running_slur_start_;
  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   events_[START] = events_[STOP] = 0;
  82 }
  83
  84 IMPLEMENT_TRANSLATOR_LISTENER (Slur_engraver, slur);
  85 void
  86 Slur_engraver::listen_slur (Stream_event *ev)
  87 {
  88   Direction d = to_dir (ev->get_property ("span-direction"));
  89   if (d == START)
  90     ASSIGN_EVENT_ONCE (events_[START], ev);
  91   else if (d == STOP)
  92     ASSIGN_EVENT_ONCE (events_[STOP], ev);
  93   else ev->origin ()->warning (_f ("direction of %s invalid: %d",
  94                                    "slur-event", int (d)));
  95 }
  96
  97 void
  98 Slur_engraver::set_melisma (bool m)
  99 {
 100   context ()->set_property ("slurMelismaBusy", m ? SCM_BOOL_T : SCM_BOOL_F);
 101 }
 102
 103 void
 104 Slur_engraver::acknowledge_note_column (Grob_info info)
 105 {
 106   Grob *e = info.grob ();
 107   for (vsize i = slurs_.size (); i--;)
 108     Slur::add_column (slurs_[i], e);
 109   for (vsize i = end_slurs_.size (); i--;)
 110     Slur::add_column (end_slurs_[i], e);
 111 }
 112
 113 void
 114 Slur_engraver::acknowledge_extra_object (Grob_info info)
 115 {
 116   Slur::auxiliary_acknowledge_extra_object (info, slurs_, end_slurs_);
 117 }
 118
 119 void
 120 Slur_engraver::acknowledge_accidental (Grob_info info)
 121 {
 122   acknowledge_extra_object (info);
 123 }
 124
 125 void
 126 Slur_engraver::acknowledge_fingering (Grob_info info)
 127 {
 128   acknowledge_extra_object (info);
 129 }
 130
 131 void
 132 Slur_engraver::acknowledge_tuplet_number (Grob_info info)
 133 {
 134   acknowledge_extra_object (info);
 135 }
 136
 137
 138 void
 139 Slur_engraver::acknowledge_script (Grob_info info)
 140 {
 141   if (!info.grob ()->internal_has_interface (ly_symbol2scm ("dynamic-interface")))
 142     acknowledge_extra_object (info);
 143 }
 144
 145 void
 146 Slur_engraver::acknowledge_text_script (Grob_info info)
 147 {
 148   acknowledge_extra_object (info);
 149 }
 150
 151 void
 152 Slur_engraver::acknowledge_tie (Grob_info info)
 153 {
 154   acknowledge_extra_object (info);
 155 }
 156
 157 void
 158 Slur_engraver::finalize ()
 159 {
 160   if (slurs_.size ())
 161     {
 162       slurs_[0]->warning (_ ("unterminated slur"));
 163       for (vsize i = 0; i < slurs_.size (); i++)
 164         slurs_[i]->suicide ();
 165     }
 166 }
 167
 168 void
 169 Slur_engraver::process_music ()
 170 {
 171   if (events_[STOP])
 172     {
 173       if (slurs_.size () == 0)
 174         events_[STOP]->origin ()->warning (_ ("cannot end slur"));
 175
 176
 177       end_slurs_ = slurs_;
 178       slurs_.clear ();
 179     }
 180
 181   if (events_[START] && slurs_.empty ())
 182     {
 183       Stream_event *ev = events_[START];
 184
 185       bool double_slurs = to_boolean (get_property ("doubleSlurs"));
 186
 187       Grob *slur = make_spanner ("Slur", events_[START]->self_scm ());
 188       Direction updown = to_dir (ev->get_property ("direction"));
 189       if (updown && !double_slurs)
 190         set_grob_direction (slur, updown);
 191
 192       slurs_.push_back (slur);
 193
 194       if (double_slurs)
 195         {
 196           set_grob_direction (slur, DOWN);
 197           slur = make_spanner ("Slur", events_[START]->self_scm ());
 198           set_grob_direction (slur, UP);
 199           slurs_.push_back (slur);
 200         }
 201     }
 202   set_melisma (slurs_.size ());
 203 }
 204
 205 void
 206 Slur_engraver::stop_translation_timestep ()
 207 {
 208   if (Grob *g = unsmob_grob (get_property ("currentCommandColumn")))
 209     {
 210       for (vsize i = 0; i < end_slurs_.size (); i++)
 211         Slur::add_extra_encompass (end_slurs_[i], g);
 212
 213       if (!events_[START])
 214         for (vsize i = 0; i < slurs_.size (); i++)
 215           Slur::add_extra_encompass (slurs_[i], g);
 216     }
 217
 218
 219   for (vsize i = 0; i < end_slurs_.size (); i++)
 220     {
 221       Spanner * s = dynamic_cast<Spanner*> (end_slurs_[i]);
 222       if (!s->get_bound (RIGHT))
 223         s->set_bound (RIGHT, unsmob_grob (get_property ("currentMusicalColumn")));
 224       announce_end_grob (s, SCM_EOL);
 225     }
 226   end_slurs_.clear ();
 227   events_[START] = events_[STOP] = 0;
 228 }
 229
 230 ADD_ACKNOWLEDGER (Slur_engraver, accidental);
 231 ADD_ACKNOWLEDGER (Slur_engraver, fingering);
 232 ADD_ACKNOWLEDGER (Slur_engraver, note_column);
 233 ADD_ACKNOWLEDGER (Slur_engraver, script);
 234 ADD_ACKNOWLEDGER (Slur_engraver, text_script);
 235 ADD_ACKNOWLEDGER (Slur_engraver, tie);
 236 ADD_ACKNOWLEDGER (Slur_engraver, tuplet_number);
 237 ADD_TRANSLATOR (Slur_engraver,
 238                 /* doc */
 239                 "Build slur grobs from slur events.",
 240
 241                 /* create */
 242                 "Slur ",
 243
 244                 /* read */
 245                 "slurMelismaBusy "
 246                 "doubleSlurs ",
 247
 248                 /* write */
 249                 ""
 250                 );