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--2009 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_ACKNOWLEDGER (tuplet_number);
  54   DECLARE_TRANSLATOR_LISTENER (phrasing_slur);
  55
  56   void stop_translation_timestep ();
  57   virtual void finalize ();
  58   void process_music ();
  59
  60 public:
  61   TRANSLATOR_DECLARATIONS (Phrasing_slur_engraver);
  62 };
  63
  64 Phrasing_slur_engraver::Phrasing_slur_engraver ()
  65 {
  66   events_[START] = events_[STOP] = 0;
  67 }
  68
  69 IMPLEMENT_TRANSLATOR_LISTENER (Phrasing_slur_engraver, phrasing_slur);
  70 void
  71 Phrasing_slur_engraver::listen_phrasing_slur (Stream_event *ev)
  72 {
  73   /*
  74     Let's not start more than one slur per moment.
  75   */
  76   Direction d = to_dir (ev->get_property ("span-direction"));
  77   if (d == START)
  78     ASSIGN_EVENT_ONCE (events_[START], ev);
  79   else if (d == STOP && !slurs_.empty ())
  80     ASSIGN_EVENT_ONCE (events_[STOP], ev);
  81 }
  82
  83 void
  84 Phrasing_slur_engraver::acknowledge_note_column (Grob_info info)
  85 {
  86   Grob *e = info.grob ();
  87   for (vsize i = slurs_.size (); i--;)
  88     Slur::add_column (slurs_[i], e);
  89   for (vsize i = end_slurs_.size (); i--;)
  90     Slur::add_column (end_slurs_[i], e);
  91 }
  92
  93 void
  94 Phrasing_slur_engraver::acknowledge_extra_object (Grob_info info)
  95 {
  96   Slur::auxiliary_acknowledge_extra_object (info, slurs_, end_slurs_);
  97 }
  98
  99 void
 100 Phrasing_slur_engraver::acknowledge_accidental (Grob_info info)
 101 {
 102   acknowledge_extra_object (info);
 103 }
 104
 105 void
 106 Phrasing_slur_engraver::acknowledge_fingering (Grob_info info)
 107 {
 108   acknowledge_extra_object (info);
 109 }
 110
 111 void
 112 Phrasing_slur_engraver::acknowledge_text_script (Grob_info info)
 113 {
 114   acknowledge_extra_object (info);
 115 }
 116
 117 void
 118 Phrasing_slur_engraver::acknowledge_script (Grob_info info)
 119 {
 120   if (!info.grob ()->internal_has_interface (ly_symbol2scm ("dynamic-interface")))
 121     acknowledge_extra_object (info);
 122 }
 123
 124 void
 125 Phrasing_slur_engraver::acknowledge_tie (Grob_info info)
 126 {
 127   acknowledge_extra_object (info);
 128 }
 129
 130 void
 131 Phrasing_slur_engraver::acknowledge_tuplet_number (Grob_info info)
 132 {
 133   acknowledge_extra_object (info);
 134 }
 135
 136 void
 137 Phrasing_slur_engraver::acknowledge_slur (Grob_info info)
 138 {
 139   acknowledge_extra_object (info);
 140 }
 141
 142 void
 143 Phrasing_slur_engraver::finalize ()
 144 {
 145   if (slurs_.size ())
 146     slurs_[0]->warning (_ ("unterminated phrasing slur"));
 147 }
 148
 149 void
 150 Phrasing_slur_engraver::process_music ()
 151 {
 152   if (events_[STOP])
 153     {
 154       end_slurs_ = slurs_;
 155       slurs_.clear ();
 156     }
 157
 158   if (events_[START] && slurs_.empty ())
 159     {
 160       Stream_event *ev = events_[START];
 161
 162       Grob *slur = make_spanner ("PhrasingSlur", events_[START]->self_scm ());
 163       Direction updown = to_dir (ev->get_property ("direction"));
 164       if (updown)
 165         set_grob_direction (slur, updown);
 166
 167       slurs_.push_back (slur);
 168     }
 169 }
 170
 171 void
 172 Phrasing_slur_engraver::stop_translation_timestep ()
 173 {
 174   end_slurs_.clear ();
 175   events_[START] = events_[STOP] = 0;
 176 }
 177
 178 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, accidental);
 179 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, fingering)
 180 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, note_column);
 181 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, slur);
 182 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, script);
 183 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, text_script);
 184 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, tie);
 185 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, tuplet_number);
 186
 187 ADD_TRANSLATOR (Phrasing_slur_engraver,
 188                 /* doc */
 189                 "Print phrasing slurs.  Similar to @ref{Slur_engraver}.",
 190
 191                 /* create */
 192                 "PhrasingSlur ",
 193
 194                 /* read */
 195                 "",
 196
 197                 /* write */
 198                 ""
 199                 );