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