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