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--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
  26 class Phrasing_slur_engraver : public Engraver
  27 {
  28   Drul_array<Music *> events_;
  29   Music *running_slur_start_;
  30   Link_array__Grob_ slurs_;
  31   Link_array__Grob_ end_slurs_;
  32
  33 protected:
  34   virtual bool try_music (Music *);
  35
  36   void acknowledge_extra_object (Grob_info);
  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 (slur);
  43   DECLARE_ACKNOWLEDGER (text_script);
  44   DECLARE_ACKNOWLEDGER (tie);
  45
  46   void stop_translation_timestep ();
  47   virtual void finalize ();
  48   void process_music ();
  49
  50 public:
  51   TRANSLATOR_DECLARATIONS (Phrasing_slur_engraver);
  52 };
  53
  54 Phrasing_slur_engraver::Phrasing_slur_engraver ()
  55 {
  56   events_[START] = events_[STOP] = 0;
  57 }
  58
  59 bool
  60 Phrasing_slur_engraver::try_music (Music *m)
  61 {
  62   if (m->is_mus_type ("phrasing-slur-event"))
  63     {
  64       /*
  65         Let's not start more than one slur per moment.
  66       */
  67       Direction d = to_dir (m->get_property ("span-direction"));
  68       if (d == START)
  69         {
  70           events_[START] = m;
  71           return true;
  72         }
  73       else if (d == STOP)
  74         {
  75           if (slurs_.empty ())
  76             return false;
  77
  78           events_[STOP] = m;
  79           return true;
  80         }
  81     }
  82   return false;
  83 }
  84
  85 void
  86 Phrasing_slur_engraver::acknowledge_note_column (Grob_info info)
  87 {
  88   Grob *e = info.grob ();
  89   for (vsize i = slurs_.size (); i--;)
  90     Slur::add_column (slurs_[i], e);
  91   for (vsize i = end_slurs_.size (); i--;)
  92     Slur::add_column (end_slurs_[i], e);
  93 }
  94
  95 /* FIXME: cut + paste job from Slur:: */
  96 void
  97 Phrasing_slur_engraver::acknowledge_extra_object (Grob_info info)
  98 {
  99   Grob *e = info.grob ();
 100   SCM avoid = e->get_property ("avoid-slur");
 101   if (Tie::has_interface (e)
 102       || avoid == ly_symbol2scm ("inside"))
 103     {
 104       for (vsize i = slurs_.size (); i--;)
 105         Slur::add_extra_encompass (slurs_[i], e);
 106       for (vsize i = end_slurs_.size (); i--;)
 107         Slur::add_extra_encompass (end_slurs_[i], e);
 108     }
 109   else if (avoid == ly_symbol2scm ("outside")
 110            || avoid == ly_symbol2scm ("around"))
 111     {
 112       Grob *slur = slurs_.size () ? slurs_[0] : 0;
 113       slur = (end_slurs_.size () && !slur)
 114         ? end_slurs_[0] : slur;
 115
 116       if (slur)
 117         {
 118           chain_offset_callback (e, Slur::outside_slur_callback_proc, Y_AXIS);
 119           e->set_object ("slur", slur->self_scm ());
 120         }
 121     }
 122 }
 123
 124 void
 125 Phrasing_slur_engraver::acknowledge_accidental (Grob_info info)
 126 {
 127   acknowledge_extra_object (info);
 128 }
 129
 130 void
 131 Phrasing_slur_engraver::acknowledge_dynamic_line_spanner (Grob_info info)
 132 {
 133   acknowledge_extra_object (info);
 134 }
 135
 136 void
 137 Phrasing_slur_engraver::acknowledge_fingering (Grob_info info)
 138 {
 139   acknowledge_extra_object (info);
 140 }
 141
 142 void
 143 Phrasing_slur_engraver::acknowledge_script (Grob_info info)
 144 {
 145   acknowledge_extra_object (info);
 146 }
 147
 148 void
 149 Phrasing_slur_engraver::acknowledge_text_script (Grob_info info)
 150 {
 151   acknowledge_extra_object (info);
 152 }
 153
 154 void
 155 Phrasing_slur_engraver::acknowledge_tie (Grob_info info)
 156 {
 157   acknowledge_extra_object (info);
 158 }
 159
 160 void
 161 Phrasing_slur_engraver::acknowledge_slur (Grob_info info)
 162 {
 163   acknowledge_extra_object (info);
 164 }
 165
 166 void
 167 Phrasing_slur_engraver::finalize ()
 168 {
 169   if (slurs_.size ())
 170     slurs_[0]->warning (_ ("unterminated phrasing slur"));
 171 }
 172
 173 void
 174 Phrasing_slur_engraver::process_music ()
 175 {
 176   if (events_[STOP])
 177     {
 178       end_slurs_ = slurs_;
 179       slurs_.clear ();
 180     }
 181
 182   if (events_[START] && slurs_.empty ())
 183     {
 184       Music *ev = events_[START];
 185
 186       Grob *slur = make_spanner ("PhrasingSlur", events_[START]->self_scm ());
 187       Direction updown = to_dir (ev->get_property ("direction"));
 188       if (updown)
 189         set_grob_direction (slur, updown);
 190
 191       slurs_.push_back (slur);
 192     }
 193 }
 194
 195 void
 196 Phrasing_slur_engraver::stop_translation_timestep ()
 197 {
 198   end_slurs_.clear ();
 199   events_[START] = events_[STOP] = 0;
 200 }
 201
 202 #include "translator.icc"
 203
 204 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, accidental);
 205 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, dynamic_line_spanner);
 206 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, fingering)
 207   ADD_ACKNOWLEDGER (Phrasing_slur_engraver, note_column);
 208 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, script);
 209 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, slur);
 210 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, text_script);
 211 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, tie);
 212
 213 ADD_TRANSLATOR (Phrasing_slur_engraver,
 214                 /* doc */ "Print phrasing slurs. Similar to @ref{Slur_engraver}",
 215                 /* create */ "PhrasingSlur",
 216                 /* accept */ "phrasing-slur-event",
 217                 /* read */ "",
 218                 /* write */ "");