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--2005 Han-Wen Nienhuys <hanwen@cs.uu.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
  17 /*
  18   It is possible that a slur starts and ends on the same note.  At
  19   least, it is for phrasing slurs: a note can be both beginning and
  20   ending of a phrase.
  21 */
  22
  23 class Phrasing_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 protected:
  31   virtual bool try_music (Music *);
  32
  33   void acknowledge_extra_object (Grob_info);
  34   DECLARE_ACKNOWLEDGER (accidental);
  35   DECLARE_ACKNOWLEDGER (dynamic_line_spanner);
  36   DECLARE_ACKNOWLEDGER (fingering);
  37   DECLARE_ACKNOWLEDGER (note_column);
  38   DECLARE_ACKNOWLEDGER (script);
  39   DECLARE_ACKNOWLEDGER (slur);
  40   DECLARE_ACKNOWLEDGER (text_script);
  41   DECLARE_ACKNOWLEDGER (tie);
  42
  43   void stop_translation_timestep ();
  44   virtual void finalize ();
  45   void process_music ();
  46
  47 public:
  48   TRANSLATOR_DECLARATIONS (Phrasing_slur_engraver);
  49 };
  50
  51 Phrasing_slur_engraver::Phrasing_slur_engraver ()
  52 {
  53   events_[START] = events_[STOP] = 0;
  54 }
  55
  56 bool
  57 Phrasing_slur_engraver::try_music (Music *m)
  58 {
  59   if (m->is_mus_type ("phrasing-slur-event"))
  60     {
  61       /*
  62         Let's not start more than one slur per moment.
  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           if (slurs_.is_empty ())
  73             return false;
  74
  75           events_[STOP] = m;
  76           return true;
  77         }
  78     }
  79   return false;
  80 }
  81
  82 void
  83 Phrasing_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 /* FIXME: cut + paste job from Slur:: */
  93 void
  94 Phrasing_slur_engraver::acknowledge_extra_object (Grob_info info)
  95 {
  96   Grob *e = info.grob ();
  97   SCM inside = e->get_property ("inside-slur");
  98   if (Tie::has_interface (e)
  99       || to_boolean (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 (inside == SCM_BOOL_F
 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           e->add_offset_callback (Slur::outside_slur_callback_proc, Y_AXIS);
 116           e->set_object ("slur", slur->self_scm ());
 117         }
 118     }
 119 }
 120
 121 void
 122 Phrasing_slur_engraver::acknowledge_accidental (Grob_info info)
 123 {
 124   acknowledge_extra_object (info);
 125 }
 126
 127 void
 128 Phrasing_slur_engraver::acknowledge_dynamic_line_spanner (Grob_info info)
 129 {
 130   acknowledge_extra_object (info);
 131 }
 132
 133 void
 134 Phrasing_slur_engraver::acknowledge_fingering (Grob_info info)
 135 {
 136   acknowledge_extra_object (info);
 137 }
 138
 139 void
 140 Phrasing_slur_engraver::acknowledge_script (Grob_info info)
 141 {
 142   acknowledge_extra_object (info);
 143 }
 144
 145 void
 146 Phrasing_slur_engraver::acknowledge_text_script (Grob_info info)
 147 {
 148   acknowledge_extra_object (info);
 149 }
 150
 151 void
 152 Phrasing_slur_engraver::acknowledge_tie (Grob_info info)
 153 {
 154   acknowledge_extra_object (info);
 155 }
 156
 157 void
 158 Phrasing_slur_engraver::acknowledge_slur (Grob_info info)
 159 {
 160   acknowledge_extra_object (info);
 161 }
 162
 163 void
 164 Phrasing_slur_engraver::finalize ()
 165 {
 166   if (slurs_.size ())
 167     slurs_[0]->warning (_ ("unterminated phrasing slur"));
 168 }
 169
 170 void
 171 Phrasing_slur_engraver::process_music ()
 172 {
 173   if (events_[STOP])
 174     {
 175       end_slurs_ = slurs_;
 176       slurs_.clear ();
 177     }
 178
 179   if (events_[START] && slurs_.is_empty ())
 180     {
 181       Music *ev = events_[START];
 182
 183       Grob *slur = make_spanner ("PhrasingSlur", events_[START]->self_scm ());
 184       Direction updown = to_dir (ev->get_property ("direction"));
 185       if (updown)
 186         set_grob_direction (slur, updown);
 187
 188       slurs_.push (slur);
 189     }
 190 }
 191
 192 void
 193 Phrasing_slur_engraver::stop_translation_timestep ()
 194 {
 195   end_slurs_.clear ();
 196   events_[START] = events_[STOP] = 0;
 197 }
 198
 199 #include "translator.icc"
 200
 201 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, accidental);
 202 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, dynamic_line_spanner);
 203 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, fingering)
 204   ADD_ACKNOWLEDGER (Phrasing_slur_engraver, note_column);
 205 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, script);
 206 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, slur);
 207 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, text_script);
 208 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, tie);
 209
 210 ADD_TRANSLATOR (Phrasing_slur_engraver,
 211                 /* doc */ "Print phrasing slurs. Similar to @ref{Slur_engraver}",
 212                 /* create */ "PhrasingSlur",
 213                 /* accept */ "phrasing-slur-event",
 214                 /* read */ "",
 215                 /* write */ "");