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--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 /*
  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 (_f ("direction of %s invalid: %d",
  84                                    "slur-event", int (d)));
  85 }
  86
  87 void
  88 Slur_engraver::set_melisma (bool m)
  89 {
  90   context ()->set_property ("slurMelismaBusy", m ? SCM_BOOL_T : SCM_BOOL_F);
  91 }
  92
  93 void
  94 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 Slur_engraver::acknowledge_extra_object (Grob_info info)
 105 {
 106   Slur::auxiliary_acknowledge_extra_object (info, slurs_, end_slurs_);
 107 }
 108
 109 void
 110 Slur_engraver::acknowledge_accidental (Grob_info info)
 111 {
 112   acknowledge_extra_object (info);
 113 }
 114
 115 void
 116 Slur_engraver::acknowledge_dynamic_line_spanner (Grob_info info)
 117 {
 118   acknowledge_extra_object (info);
 119 }
 120
 121 void
 122 Slur_engraver::acknowledge_fingering (Grob_info info)
 123 {
 124   acknowledge_extra_object (info);
 125 }
 126
 127 void
 128 Slur_engraver::acknowledge_tuplet_number (Grob_info info)
 129 {
 130   acknowledge_extra_object (info);
 131 }
 132
 133
 134 void
 135 Slur_engraver::acknowledge_script (Grob_info info)
 136 {
 137   if (!info.grob ()->internal_has_interface (ly_symbol2scm ("dynamic-interface")))
 138     acknowledge_extra_object (info);
 139 }
 140
 141 void
 142 Slur_engraver::acknowledge_text_script (Grob_info info)
 143 {
 144   acknowledge_extra_object (info);
 145 }
 146
 147 void
 148 Slur_engraver::acknowledge_tie (Grob_info info)
 149 {
 150   acknowledge_extra_object (info);
 151 }
 152
 153 void
 154 Slur_engraver::finalize ()
 155 {
 156   if (slurs_.size ())
 157     {
 158       slurs_[0]->warning (_ ("unterminated slur"));
 159       for (vsize i = 0; i < slurs_.size (); i++)
 160         slurs_[i]->suicide ();
 161     }
 162 }
 163
 164 void
 165 Slur_engraver::process_music ()
 166 {
 167   if (events_[STOP])
 168     {
 169       if (slurs_.size () == 0)
 170         events_[STOP]->origin ()->warning (_ ("cannot end slur"));
 171
 172
 173       end_slurs_ = slurs_;
 174       slurs_.clear ();
 175     }
 176
 177   if (events_[START] && slurs_.empty ())
 178     {
 179       Stream_event *ev = events_[START];
 180
 181       bool double_slurs = to_boolean (get_property ("doubleSlurs"));
 182
 183       Grob *slur = make_spanner ("Slur", events_[START]->self_scm ());
 184       Direction updown = to_dir (ev->get_property ("direction"));
 185       if (updown && !double_slurs)
 186         set_grob_direction (slur, updown);
 187
 188       slurs_.push_back (slur);
 189
 190       if (double_slurs)
 191         {
 192           set_grob_direction (slur, DOWN);
 193           slur = make_spanner ("Slur", events_[START]->self_scm ());
 194           set_grob_direction (slur, UP);
 195           slurs_.push_back (slur);
 196         }
 197     }
 198   set_melisma (slurs_.size ());
 199 }
 200
 201 void
 202 Slur_engraver::stop_translation_timestep ()
 203 {
 204   if (Grob *g = unsmob_grob (get_property ("breakableSeparationItem")))
 205     {
 206       for (vsize i = 0; i < end_slurs_.size (); i++)
 207         Slur::add_extra_encompass (end_slurs_[i], g);
 208
 209       if (!events_[START])
 210         for (vsize i = 0; i < slurs_.size (); i++)
 211           Slur::add_extra_encompass (slurs_[i], g);
 212     }
 213
 214
 215   for (vsize i = 0; i < end_slurs_.size (); i++)
 216     {
 217       Spanner * s = dynamic_cast<Spanner*> (end_slurs_[i]);
 218       if (!s->get_bound (RIGHT))
 219         s->set_bound (RIGHT, unsmob_grob (get_property ("currentMusicalColumn")));
 220       announce_end_grob (s, SCM_EOL);
 221     }
 222   end_slurs_.clear ();
 223   events_[START] = events_[STOP] = 0;
 224 }
 225
 226 ADD_ACKNOWLEDGER (Slur_engraver, accidental);
 227 ADD_ACKNOWLEDGER (Slur_engraver, dynamic_line_spanner);
 228 ADD_ACKNOWLEDGER (Slur_engraver, fingering);
 229 ADD_ACKNOWLEDGER (Slur_engraver, note_column);
 230 ADD_ACKNOWLEDGER (Slur_engraver, script);
 231 ADD_ACKNOWLEDGER (Slur_engraver, text_script);
 232 ADD_ACKNOWLEDGER (Slur_engraver, tie);
 233 ADD_ACKNOWLEDGER (Slur_engraver, tuplet_number);
 234 ADD_TRANSLATOR (Slur_engraver,
 235                 /* doc */ "Build slur grobs from slur events",
 236                 /* create */ "Slur",
 237                 /* read */
 238                 "slurMelismaBusy "
 239                 "doubleSlurs ",
 240
 241                 /* write */ "");