lily/slur-engraver.cc

   1 /*
   2   slur-engraver.cc -- implement Slur_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2006 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 /*
  24   NOTE NOTE NOTE
  25
  26   This is largely similar to Phrasing_slur_engraver. Check if fixes
  27   apply there too.
  28
  29   (on principle, engravers don't use inheritance for code sharing)
  30
  31  */
  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 class Slur_engraver : public Engraver
  39 {
  40   Drul_array<Stream_event *> events_;
  41   Stream_event *running_slur_start_;
  42   vector<Grob*> slurs_;
  43   vector<Grob*> end_slurs_;
  44
  45   void set_melisma (bool);
  46
  47 protected:
  48   DECLARE_TRANSLATOR_LISTENER (slur);
  49   DECLARE_ACKNOWLEDGER (accidental);
  50   DECLARE_ACKNOWLEDGER (dynamic_line_spanner);
  51   DECLARE_ACKNOWLEDGER (fingering);
  52   DECLARE_ACKNOWLEDGER (note_column);
  53   DECLARE_ACKNOWLEDGER (script);
  54   DECLARE_ACKNOWLEDGER (text_script);
  55   DECLARE_ACKNOWLEDGER (tie);
  56   DECLARE_ACKNOWLEDGER (tuplet_number);
  57
  58   void acknowledge_extra_object (Grob_info);
  59   void stop_translation_timestep ();
  60   void process_music ();
  61
  62   virtual void finalize ();
  63
  64
  65 public:
  66   TRANSLATOR_DECLARATIONS (Slur_engraver);
  67 };
  68
  69 Slur_engraver::Slur_engraver ()
  70 {
  71   events_[START] = events_[STOP] = 0;
  72 }
  73
  74 IMPLEMENT_TRANSLATOR_LISTENER (Slur_engraver, slur);
  75 void
  76 Slur_engraver::listen_slur (Stream_event *ev)
  77 {
  78   Direction d = to_dir (ev->get_property ("span-direction"));
  79   if (d == START)
  80     ASSIGN_EVENT_ONCE (events_[START], ev);
  81   else if (d == STOP)
  82     ASSIGN_EVENT_ONCE (events_[STOP], ev);
  83   else ev->origin ()->warning (_ ("Invalid direction of slur-event"));
  84 }
  85
  86 void
  87 Slur_engraver::set_melisma (bool m)
  88 {
  89   context ()->set_property ("slurMelismaBusy", m ? SCM_BOOL_T : SCM_BOOL_F);
  90 }
  91
  92 void
  93 Slur_engraver::acknowledge_note_column (Grob_info info)
  94 {
  95   Grob *e = info.grob ();
  96   for (vsize i = slurs_.size (); i--;)
  97     Slur::add_column (slurs_[i], e);
  98   for (vsize i = end_slurs_.size (); i--;)
  99     Slur::add_column (end_slurs_[i], e);
 100 }
 101
 102 void
 103 Slur_engraver::acknowledge_extra_object (Grob_info info)
 104 {
 105   Slur::auxiliary_acknowledge_extra_object (info, slurs_, end_slurs_);
 106 }
 107
 108 void
 109 Slur_engraver::acknowledge_accidental (Grob_info info)
 110 {
 111   acknowledge_extra_object (info);
 112 }
 113
 114 void
 115 Slur_engraver::acknowledge_dynamic_line_spanner (Grob_info info)
 116 {
 117   acknowledge_extra_object (info);
 118 }
 119
 120 void
 121 Slur_engraver::acknowledge_fingering (Grob_info info)
 122 {
 123   acknowledge_extra_object (info);
 124 }
 125
 126 void
 127 Slur_engraver::acknowledge_tuplet_number (Grob_info info)
 128 {
 129   acknowledge_extra_object (info);
 130 }
 131
 132
 133 void
 134 Slur_engraver::acknowledge_script (Grob_info info)
 135 {
 136   if (!info.grob ()->internal_has_interface (ly_symbol2scm ("dynamic-interface")))
 137     acknowledge_extra_object (info);
 138 }
 139
 140 void
 141 Slur_engraver::acknowledge_text_script (Grob_info info)
 142 {
 143   acknowledge_extra_object (info);
 144 }
 145
 146 void
 147 Slur_engraver::acknowledge_tie (Grob_info info)
 148 {
 149   acknowledge_extra_object (info);
 150 }
 151
 152 void
 153 Slur_engraver::finalize ()
 154 {
 155   if (slurs_.size ())
 156     slurs_[0]->warning (_ ("unterminated slur"));
 157 }
 158
 159 void
 160 Slur_engraver::process_music ()
 161 {
 162   if (events_[STOP])
 163     {
 164       if (slurs_.size () == 0)
 165         events_[STOP]->origin ()->warning (_ ("can't end slur"));
 166
 167
 168       end_slurs_ = slurs_;
 169       slurs_.clear ();
 170     }
 171
 172   if (events_[START] && slurs_.empty ())
 173     {
 174       Stream_event *ev = events_[START];
 175
 176       bool double_slurs = to_boolean (get_property ("doubleSlurs"));
 177
 178       Grob *slur = make_spanner ("Slur", events_[START]->self_scm ());
 179       Direction updown = to_dir (ev->get_property ("direction"));
 180       if (updown && !double_slurs)
 181         set_grob_direction (slur, updown);
 182
 183       slurs_.push_back (slur);
 184
 185       if (double_slurs)
 186         {
 187           set_grob_direction (slur, DOWN);
 188           slur = make_spanner ("Slur", events_[START]->self_scm ());
 189           set_grob_direction (slur, UP);
 190           slurs_.push_back (slur);
 191         }
 192     }
 193   set_melisma (slurs_.size ());
 194 }
 195
 196 void
 197 Slur_engraver::stop_translation_timestep ()
 198 {
 199   if (Grob *g = unsmob_grob (get_property ("breakableSeparationItem")))
 200     {
 201       for (vsize i = 0; i < end_slurs_.size (); i++)
 202         Slur::add_extra_encompass (end_slurs_[i], g);
 203
 204       if (!events_[START])
 205         for (vsize i = 0; i < slurs_.size (); i++)
 206           Slur::add_extra_encompass (slurs_[i], g);
 207     }
 208
 209
 210   for (vsize i = 0; i < end_slurs_.size (); i++)
 211     announce_end_grob (end_slurs_[i], SCM_EOL);
 212   end_slurs_.clear ();
 213   events_[START] = events_[STOP] = 0;
 214 }
 215
 216 ADD_ACKNOWLEDGER (Slur_engraver, accidental);
 217 ADD_ACKNOWLEDGER (Slur_engraver, dynamic_line_spanner);
 218 ADD_ACKNOWLEDGER (Slur_engraver, fingering);
 219 ADD_ACKNOWLEDGER (Slur_engraver, note_column);
 220 ADD_ACKNOWLEDGER (Slur_engraver, script);
 221 ADD_ACKNOWLEDGER (Slur_engraver, text_script);
 222 ADD_ACKNOWLEDGER (Slur_engraver, tie);
 223 ADD_ACKNOWLEDGER (Slur_engraver, tuplet_number);
 224 ADD_TRANSLATOR (Slur_engraver,
 225                 /* doc */ "Build slur grobs from slur events",
 226                 /* create */ "Slur",
 227                 /* read */
 228                 "slurMelismaBusy "
 229                 "doubleSlurs ",
 230
 231                 /* write */ "");