lily/phrasing-slur-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2009 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   It is possible that a slur starts and ends on the same note.  At
  35   least, it is for phrasing slurs: a note can be both beginning and
  36   ending of a phrase.
  37
  38 */
  39
  40 /*
  41   NOTE NOTE NOTE
  42
  43   This is largely similar to Slur_engraver. Check if fixes apply there too.
  44
  45   (on principle, engravers don't use inheritance for code sharing)
  46
  47  */
  48 class Phrasing_slur_engraver : public Engraver
  49 {
  50   Drul_array<Stream_event *> events_;
  51   Stream_event *running_slur_start_;
  52   vector<Grob*> slurs_;
  53   vector<Grob*> end_slurs_;
  54
  55 protected:
  56   void acknowledge_extra_object (Grob_info);
  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   DECLARE_TRANSLATOR_LISTENER (phrasing_slur);
  66
  67   void stop_translation_timestep ();
  68   virtual void finalize ();
  69   void process_music ();
  70
  71 public:
  72   TRANSLATOR_DECLARATIONS (Phrasing_slur_engraver);
  73 };
  74
  75 Phrasing_slur_engraver::Phrasing_slur_engraver ()
  76 {
  77   events_[START] = events_[STOP] = 0;
  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   /*
  85     Let's not start more than one slur per moment.
  86   */
  87   Direction d = to_dir (ev->get_property ("span-direction"));
  88   if (d == START)
  89     ASSIGN_EVENT_ONCE (events_[START], ev);
  90   else if (d == STOP && !slurs_.empty ())
  91     ASSIGN_EVENT_ONCE (events_[STOP], ev);
  92 }
  93
  94 void
  95 Phrasing_slur_engraver::acknowledge_note_column (Grob_info info)
  96 {
  97   Grob *e = info.grob ();
  98   for (vsize i = slurs_.size (); i--;)
  99     Slur::add_column (slurs_[i], e);
 100   for (vsize i = end_slurs_.size (); i--;)
 101     Slur::add_column (end_slurs_[i], e);
 102 }
 103
 104 void
 105 Phrasing_slur_engraver::acknowledge_extra_object (Grob_info info)
 106 {
 107   Slur::auxiliary_acknowledge_extra_object (info, slurs_, end_slurs_);
 108 }
 109
 110 void
 111 Phrasing_slur_engraver::acknowledge_accidental (Grob_info info)
 112 {
 113   acknowledge_extra_object (info);
 114 }
 115
 116 void
 117 Phrasing_slur_engraver::acknowledge_fingering (Grob_info info)
 118 {
 119   acknowledge_extra_object (info);
 120 }
 121
 122 void
 123 Phrasing_slur_engraver::acknowledge_text_script (Grob_info info)
 124 {
 125   acknowledge_extra_object (info);
 126 }
 127
 128 void
 129 Phrasing_slur_engraver::acknowledge_script (Grob_info info)
 130 {
 131   if (!info.grob ()->internal_has_interface (ly_symbol2scm ("dynamic-interface")))
 132     acknowledge_extra_object (info);
 133 }
 134
 135 void
 136 Phrasing_slur_engraver::acknowledge_tie (Grob_info info)
 137 {
 138   acknowledge_extra_object (info);
 139 }
 140
 141 void
 142 Phrasing_slur_engraver::acknowledge_tuplet_number (Grob_info info)
 143 {
 144   acknowledge_extra_object (info);
 145 }
 146
 147 void
 148 Phrasing_slur_engraver::acknowledge_slur (Grob_info info)
 149 {
 150   acknowledge_extra_object (info);
 151 }
 152
 153 void
 154 Phrasing_slur_engraver::finalize ()
 155 {
 156   if (slurs_.size ())
 157     slurs_[0]->warning (_ ("unterminated phrasing slur"));
 158 }
 159
 160 void
 161 Phrasing_slur_engraver::process_music ()
 162 {
 163   if (events_[STOP])
 164     {
 165       end_slurs_ = slurs_;
 166       slurs_.clear ();
 167     }
 168
 169   if (events_[START] && slurs_.empty ())
 170     {
 171       Stream_event *ev = events_[START];
 172
 173       Grob *slur = make_spanner ("PhrasingSlur", events_[START]->self_scm ());
 174       Direction updown = to_dir (ev->get_property ("direction"));
 175       if (updown)
 176         set_grob_direction (slur, updown);
 177
 178       slurs_.push_back (slur);
 179     }
 180 }
 181
 182 void
 183 Phrasing_slur_engraver::stop_translation_timestep ()
 184 {
 185   end_slurs_.clear ();
 186   events_[START] = events_[STOP] = 0;
 187 }
 188
 189 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, accidental);
 190 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, fingering)
 191 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, note_column);
 192 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, slur);
 193 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, script);
 194 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, text_script);
 195 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, tie);
 196 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, tuplet_number);
 197
 198 ADD_TRANSLATOR (Phrasing_slur_engraver,
 199                 /* doc */
 200                 "Print phrasing slurs.  Similar to @ref{Slur_engraver}.",
 201
 202                 /* create */
 203                 "PhrasingSlur ",
 204
 205                 /* read */
 206                 "",
 207
 208                 /* write */
 209                 ""
 210                 );