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   DECLARE_ACKNOWLEDGER (tuplet_number);
  43   void acknowledge_extra_object (Grob_info);
  44   void stop_translation_timestep ();
  45   virtual void finalize ();
  46   void process_music ();
  47
  48 public:
  49   TRANSLATOR_DECLARATIONS (Slur_engraver);
  50 };
  51
  52 Slur_engraver::Slur_engraver ()
  53 {
  54   events_[START] = events_[STOP] = 0;
  55 }
  56
  57 bool
  58 Slur_engraver::try_music (Music *m)
  59 {
  60   if (m->is_mus_type ("slur-event"))
  61     {
  62       Direction d = to_dir (m->get_property ("span-direction"));
  63       if (d == START)
  64         {
  65           events_[START] = m;
  66           return true;
  67         }
  68       else if (d == STOP)
  69         {
  70           events_[STOP] = m;
  71           return true;
  72         }
  73     }
  74   return false;
  75 }
  76
  77 void
  78 Slur_engraver::set_melisma (bool m)
  79 {
  80   context ()->set_property ("slurMelismaBusy", m ? SCM_BOOL_T : SCM_BOOL_F);
  81 }
  82
  83 void
  84 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 void
  94 Slur_engraver::acknowledge_extra_object (Grob_info info)
  95 {
  96   Grob *e = info.grob ();
  97   SCM avoid = e->get_property ("avoid-slur");
  98   if (Tie::has_interface (e)
  99       || avoid == ly_symbol2scm ("inside"))
 100     {
 101       for (int i = slurs_.size (); i--;)
 102         Slur::add_extra_encompass (slurs_[i], e);
 103       for (int i = end_slurs_.size (); i--;)
 104         Slur::add_extra_encompass (end_slurs_[i], e);
 105     }
 106   else if ((avoid == ly_symbol2scm ("outside")
 107             || avoid == ly_symbol2scm ("around"))
 108            && e->name () != "DynamicText")
 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   else
 121     e->warning ("Ignoring grob for slur. avoid-slur not set?");
 122 }
 123
 124 void
 125 Slur_engraver::acknowledge_accidental (Grob_info info)
 126 {
 127   acknowledge_extra_object (info);
 128 }
 129
 130 void
 131 Slur_engraver::acknowledge_dynamic_line_spanner (Grob_info info)
 132 {
 133   acknowledge_extra_object (info);
 134 }
 135
 136 void
 137 Slur_engraver::acknowledge_fingering (Grob_info info)
 138 {
 139   acknowledge_extra_object (info);
 140 }
 141
 142 void
 143 Slur_engraver::acknowledge_tuplet_number (Grob_info info)
 144 {
 145   acknowledge_extra_object (info);
 146 }
 147
 148
 149 void
 150 Slur_engraver::acknowledge_script (Grob_info info)
 151 {
 152   acknowledge_extra_object (info);
 153 }
 154
 155 void
 156 Slur_engraver::acknowledge_text_script (Grob_info info)
 157 {
 158   acknowledge_extra_object (info);
 159 }
 160
 161 void
 162 Slur_engraver::acknowledge_tie (Grob_info info)
 163 {
 164   acknowledge_extra_object (info);
 165 }
 166
 167 void
 168 Slur_engraver::finalize ()
 169 {
 170   if (slurs_.size ())
 171     slurs_[0]->warning (_ ("unterminated slur"));
 172 }
 173
 174 void
 175 Slur_engraver::process_music ()
 176 {
 177   if (events_[STOP])
 178     {
 179       if (slurs_.size () == 0)
 180         events_[STOP]->origin ()->warning (_ ("can't end slur"));
 181
 182       end_slurs_ = slurs_;
 183       slurs_.clear ();
 184     }
 185
 186   if (events_[START] && slurs_.is_empty ())
 187     {
 188       Music *ev = events_[START];
 189
 190       bool double_slurs = to_boolean (get_property ("doubleSlurs"));
 191
 192       Grob *slur = make_spanner ("Slur", events_[START]->self_scm ());
 193       Direction updown = to_dir (ev->get_property ("direction"));
 194       if (updown && !double_slurs)
 195         set_grob_direction (slur, updown);
 196
 197       slurs_.push (slur);
 198
 199       if (double_slurs)
 200         {
 201           set_grob_direction (slur, DOWN);
 202           slur = make_spanner ("Slur", events_[START]->self_scm ());
 203           set_grob_direction (slur, UP);
 204           slurs_.push (slur);
 205         }
 206     }
 207   set_melisma (slurs_.size ());
 208 }
 209
 210 void
 211 Slur_engraver::stop_translation_timestep ()
 212 {
 213   end_slurs_.clear ();
 214   events_[START] = events_[STOP] = 0;
 215 }
 216
 217 #include "translator.icc"
 218
 219 ADD_ACKNOWLEDGER (Slur_engraver, accidental);
 220 ADD_ACKNOWLEDGER (Slur_engraver, dynamic_line_spanner);
 221 ADD_ACKNOWLEDGER (Slur_engraver, fingering);
 222 ADD_ACKNOWLEDGER (Slur_engraver, note_column);
 223 ADD_ACKNOWLEDGER (Slur_engraver, script);
 224 ADD_ACKNOWLEDGER (Slur_engraver, text_script);
 225 ADD_ACKNOWLEDGER (Slur_engraver, tie);
 226 ADD_ACKNOWLEDGER (Slur_engraver, tuplet_number);
 227 ADD_TRANSLATOR (Slur_engraver,
 228                 /* doc */ "Build slur grobs from slur events",
 229                 /* create */ "Slur",
 230                 /* accept */ "slur-event",
 231                 /* read */ "slurMelismaBusy doubleSlurs",
 232                 /* write */ "");