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