lily/phrasing-slur-engraver.cc

   1 /*
   2   phrasing-slur-engraver.cc -- implement Phrasing_slur_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "engraver.hh"
  10
  11 #include "context.hh"
  12 #include "directional-element-interface.hh"
  13 #include "international.hh"
  14 #include "note-column.hh"
  15 #include "slur.hh"
  16 #include "spanner.hh"
  17 #include "stream-event.hh"
  18 #include "warn.hh"
  19
  20 #include "translator.icc"
  21
  22 /*
  23   It is possible that a slur starts and ends on the same note.  At
  24   least, it is for phrasing slurs: a note can be both beginning and
  25   ending of a phrase.
  26
  27 */
  28
  29 /*
  30   NOTE NOTE NOTE
  31
  32   This is largely similar to Slur_engraver. Check if fixes apply there too.
  33
  34   (on principle, engravers don't use inheritance for code sharing)
  35
  36  */
  37 class Phrasing_slur_engraver : public Engraver
  38 {
  39   Drul_array<Stream_event *> events_;
  40   Stream_event *running_slur_start_;
  41   vector<Grob*> slurs_;
  42   vector<Grob*> end_slurs_;
  43
  44 protected:
  45   void acknowledge_extra_object (Grob_info);
  46   DECLARE_ACKNOWLEDGER (accidental);
  47   DECLARE_ACKNOWLEDGER (fingering);
  48   DECLARE_ACKNOWLEDGER (note_column);
  49   DECLARE_ACKNOWLEDGER (slur);
  50   DECLARE_ACKNOWLEDGER (script);
  51   DECLARE_ACKNOWLEDGER (text_script);
  52   DECLARE_ACKNOWLEDGER (tie);
  53   DECLARE_TRANSLATOR_LISTENER (phrasing_slur);
  54
  55   void stop_translation_timestep ();
  56   virtual void finalize ();
  57   void process_music ();
  58
  59 public:
  60   TRANSLATOR_DECLARATIONS (Phrasing_slur_engraver);
  61 };
  62
  63 Phrasing_slur_engraver::Phrasing_slur_engraver ()
  64 {
  65   events_[START] = events_[STOP] = 0;
  66 }
  67
  68 IMPLEMENT_TRANSLATOR_LISTENER (Phrasing_slur_engraver, phrasing_slur);
  69 void
  70 Phrasing_slur_engraver::listen_phrasing_slur (Stream_event *ev)
  71 {
  72   /*
  73     Let's not start more than one slur per moment.
  74   */
  75   Direction d = to_dir (ev->get_property ("span-direction"));
  76   if (d == START)
  77     ASSIGN_EVENT_ONCE (events_[START], ev);
  78   else if (d == STOP && !slurs_.empty ())
  79     ASSIGN_EVENT_ONCE (events_[STOP], ev);
  80 }
  81
  82 void
  83 Phrasing_slur_engraver::acknowledge_note_column (Grob_info info)
  84 {
  85   Grob *e = info.grob ();
  86   for (vsize i = slurs_.size (); i--;)
  87     Slur::add_column (slurs_[i], e);
  88   for (vsize i = end_slurs_.size (); i--;)
  89     Slur::add_column (end_slurs_[i], e);
  90 }
  91
  92 void
  93 Phrasing_slur_engraver::acknowledge_extra_object (Grob_info info)
  94 {
  95   Slur::auxiliary_acknowledge_extra_object (info, slurs_, end_slurs_);
  96 }
  97
  98 void
  99 Phrasing_slur_engraver::acknowledge_accidental (Grob_info info)
 100 {
 101   acknowledge_extra_object (info);
 102 }
 103
 104 void
 105 Phrasing_slur_engraver::acknowledge_fingering (Grob_info info)
 106 {
 107   acknowledge_extra_object (info);
 108 }
 109
 110 void
 111 Phrasing_slur_engraver::acknowledge_text_script (Grob_info info)
 112 {
 113   acknowledge_extra_object (info);
 114 }
 115
 116 void
 117 Phrasing_slur_engraver::acknowledge_script (Grob_info info)
 118 {
 119   if (!info.grob ()->internal_has_interface (ly_symbol2scm ("dynamic-interface")))
 120     acknowledge_extra_object (info);
 121 }
 122
 123 void
 124 Phrasing_slur_engraver::acknowledge_tie (Grob_info info)
 125 {
 126   acknowledge_extra_object (info);
 127 }
 128
 129 void
 130 Phrasing_slur_engraver::acknowledge_slur (Grob_info info)
 131 {
 132   acknowledge_extra_object (info);
 133 }
 134
 135 void
 136 Phrasing_slur_engraver::finalize ()
 137 {
 138   if (slurs_.size ())
 139     slurs_[0]->warning (_ ("unterminated phrasing slur"));
 140 }
 141
 142 void
 143 Phrasing_slur_engraver::process_music ()
 144 {
 145   if (events_[STOP])
 146     {
 147       end_slurs_ = slurs_;
 148       slurs_.clear ();
 149     }
 150
 151   if (events_[START] && slurs_.empty ())
 152     {
 153       Stream_event *ev = events_[START];
 154
 155       Grob *slur = make_spanner ("PhrasingSlur", events_[START]->self_scm ());
 156       Direction updown = to_dir (ev->get_property ("direction"));
 157       if (updown)
 158         set_grob_direction (slur, updown);
 159
 160       slurs_.push_back (slur);
 161     }
 162 }
 163
 164 void
 165 Phrasing_slur_engraver::stop_translation_timestep ()
 166 {
 167   end_slurs_.clear ();
 168   events_[START] = events_[STOP] = 0;
 169 }
 170
 171 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, accidental);
 172 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, fingering)
 173 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, note_column);
 174 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, slur);
 175 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, script);
 176 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, text_script);
 177 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, tie);
 178
 179 ADD_TRANSLATOR (Phrasing_slur_engraver,
 180                 /* doc */ "Print phrasing slurs. Similar to @ref{Slur_engraver}",
 181                 /* create */ "PhrasingSlur",
 182                 /* read */ "",
 183                 /* write */ "");