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 "tie.hh"
  18 #include "warn.hh"
  19
  20 /*
  21   It is possible that a slur starts and ends on the same note.  At
  22   least, it is for phrasing slurs: a note can be both beginning and
  23   ending of a phrase.
  24 */
  25 class Slur_engraver : public Engraver
  26 {
  27   Drul_array<Music *> events_;
  28   Music *running_slur_start_;
  29   Link_array<Grob> slurs_;
  30   Link_array<Grob> end_slurs_;
  31
  32   void set_melisma (bool);
  33
  34 protected:
  35   virtual bool try_music (Music *);
  36
  37   DECLARE_ACKNOWLEDGER (accidental);
  38   DECLARE_ACKNOWLEDGER (dynamic_line_spanner);
  39   DECLARE_ACKNOWLEDGER (fingering);
  40   DECLARE_ACKNOWLEDGER (note_column);
  41   DECLARE_ACKNOWLEDGER (script);
  42   DECLARE_ACKNOWLEDGER (text_script);
  43   DECLARE_ACKNOWLEDGER (tie);
  44   DECLARE_ACKNOWLEDGER (tuplet_number);
  45   void acknowledge_extra_object (Grob_info);
  46   void stop_translation_timestep ();
  47   virtual void finalize ();
  48   void process_music ();
  49
  50 public:
  51   TRANSLATOR_DECLARATIONS (Slur_engraver);
  52 };
  53
  54 Slur_engraver::Slur_engraver ()
  55 {
  56   events_[START] = events_[STOP] = 0;
  57 }
  58
  59 bool
  60 Slur_engraver::try_music (Music *m)
  61 {
  62   if (m->is_mus_type ("slur-event"))
  63     {
  64       Direction d = to_dir (m->get_property ("span-direction"));
  65       if (d == START)
  66         {
  67           events_[START] = m;
  68           return true;
  69         }
  70       else if (d == STOP)
  71         {
  72           events_[STOP] = m;
  73           return true;
  74         }
  75     }
  76   return false;
  77 }
  78
  79 void
  80 Slur_engraver::set_melisma (bool m)
  81 {
  82   context ()->set_property ("slurMelismaBusy", m ? SCM_BOOL_T : SCM_BOOL_F);
  83 }
  84
  85 void
  86 Slur_engraver::acknowledge_note_column (Grob_info info)
  87 {
  88   Grob *e = info.grob ();
  89   for (int i = slurs_.size (); i--;)
  90     Slur::add_column (slurs_[i], e);
  91   for (int i = end_slurs_.size (); i--;)
  92     Slur::add_column (end_slurs_[i], e);
  93 }
  94
  95 void
  96 Slur_engraver::acknowledge_extra_object (Grob_info info)
  97 {
  98   if (slurs_.is_empty ()
  99       && end_slurs_.is_empty ())
 100     return ;
 101
 102   Grob *e = info.grob ();
 103   SCM avoid = e->get_property ("avoid-slur");
 104   if (Tie::has_interface (e)
 105       || avoid == ly_symbol2scm ("inside"))
 106     {
 107       for (int i = slurs_.size (); i--;)
 108         Slur::add_extra_encompass (slurs_[i], e);
 109       for (int i = end_slurs_.size (); i--;)
 110         Slur::add_extra_encompass (end_slurs_[i], e);
 111     }
 112   else if (avoid == ly_symbol2scm ("outside")
 113            || avoid == ly_symbol2scm ("around"))
 114     {
 115       Grob *slur = slurs_.size () ? slurs_[0] : 0;
 116       slur = (end_slurs_.size () && !slur)
 117         ? end_slurs_[0] : slur;
 118
 119       if (slur)
 120         {
 121           chain_offset_callback (e, Slur::outside_slur_callback_proc, Y_AXIS);
 122           e->set_object ("slur", slur->self_scm ());
 123         }
 124     }
 125   else
 126     e->warning ("Ignoring grob for slur. avoid-slur not set?");
 127 }
 128
 129 void
 130 Slur_engraver::acknowledge_accidental (Grob_info info)
 131 {
 132   acknowledge_extra_object (info);
 133 }
 134
 135 void
 136 Slur_engraver::acknowledge_dynamic_line_spanner (Grob_info info)
 137 {
 138   acknowledge_extra_object (info);
 139 }
 140
 141 void
 142 Slur_engraver::acknowledge_fingering (Grob_info info)
 143 {
 144   acknowledge_extra_object (info);
 145 }
 146
 147 void
 148 Slur_engraver::acknowledge_tuplet_number (Grob_info info)
 149 {
 150   acknowledge_extra_object (info);
 151 }
 152
 153
 154 void
 155 Slur_engraver::acknowledge_script (Grob_info info)
 156 {
 157   acknowledge_extra_object (info);
 158 }
 159
 160 void
 161 Slur_engraver::acknowledge_text_script (Grob_info info)
 162 {
 163   //  if (!info.grob ()->internal_has_interface (ly_symbol2scm ("DynamicText")))
 164   acknowledge_extra_object (info);
 165 }
 166
 167 void
 168 Slur_engraver::acknowledge_tie (Grob_info info)
 169 {
 170   acknowledge_extra_object (info);
 171 }
 172
 173 void
 174 Slur_engraver::finalize ()
 175 {
 176   if (slurs_.size ())
 177     slurs_[0]->warning (_ ("unterminated slur"));
 178 }
 179
 180 void
 181 Slur_engraver::process_music ()
 182 {
 183   if (events_[STOP])
 184     {
 185       if (slurs_.size () == 0)
 186         events_[STOP]->origin ()->warning (_ ("can't end slur"));
 187
 188       end_slurs_ = slurs_;
 189       slurs_.clear ();
 190     }
 191
 192   if (events_[START] && slurs_.is_empty ())
 193     {
 194       Music *ev = events_[START];
 195
 196       bool double_slurs = to_boolean (get_property ("doubleSlurs"));
 197
 198       Grob *slur = make_spanner ("Slur", events_[START]->self_scm ());
 199       Direction updown = to_dir (ev->get_property ("direction"));
 200       if (updown && !double_slurs)
 201         set_grob_direction (slur, updown);
 202
 203       slurs_.push (slur);
 204
 205       if (double_slurs)
 206         {
 207           set_grob_direction (slur, DOWN);
 208           slur = make_spanner ("Slur", events_[START]->self_scm ());
 209           set_grob_direction (slur, UP);
 210           slurs_.push (slur);
 211         }
 212     }
 213   set_melisma (slurs_.size ());
 214 }
 215
 216 void
 217 Slur_engraver::stop_translation_timestep ()
 218 {
 219   end_slurs_.clear ();
 220   events_[START] = events_[STOP] = 0;
 221 }
 222
 223 #include "translator.icc"
 224
 225 ADD_ACKNOWLEDGER (Slur_engraver, accidental);
 226 ADD_ACKNOWLEDGER (Slur_engraver, dynamic_line_spanner);
 227 ADD_ACKNOWLEDGER (Slur_engraver, fingering);
 228 ADD_ACKNOWLEDGER (Slur_engraver, note_column);
 229 ADD_ACKNOWLEDGER (Slur_engraver, script);
 230 ADD_ACKNOWLEDGER (Slur_engraver, text_script);
 231 ADD_ACKNOWLEDGER (Slur_engraver, tie);
 232 ADD_ACKNOWLEDGER (Slur_engraver, tuplet_number);
 233 ADD_TRANSLATOR (Slur_engraver,
 234                 /* doc */ "Build slur grobs from slur events",
 235                 /* create */ "Slur",
 236                 /* accept */ "slur-event",
 237                 /* read */ "slurMelismaBusy doubleSlurs",
 238                 /* write */ "");