lily/new-lyric-combine-music-iterator.cc

   1 /*
   2   new-lyric-combine-iterator.cc -- implement Lyric_combine_music_iterator
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2004--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "context.hh"
  10 #include "grob.hh"
  11 #include "input.hh"
  12 #include "international.hh"
  13 #include "music-iterator.hh"
  14 #include "music.hh"
  15
  16 class Lyric_combine_music_iterator : public Music_iterator
  17 {
  18 public:
  19   Lyric_combine_music_iterator ();
  20   Lyric_combine_music_iterator (Lyric_combine_music_iterator const &src);
  21   DECLARE_SCHEME_CALLBACK (constructor, ());
  22 protected:
  23   virtual void construct_children ();
  24   virtual Moment pending_moment () const;
  25   virtual void do_quit ();
  26   virtual void process (Moment);
  27   virtual Music_iterator *try_music_in_children (Music *) const;
  28   virtual bool run_always ()const;
  29   virtual bool ok () const;
  30   virtual void derived_mark () const;
  31   virtual void derived_substitute (Context *, Context *);
  32 private:
  33   bool start_new_syllable ();
  34   void find_voice ();
  35
  36   bool music_found_;
  37   bool made_association_;
  38   Context *lyrics_context_;
  39   Context *music_context_;
  40   SCM lyricsto_voice_name_;
  41
  42   Music_iterator *lyric_iter_;
  43 };
  44
  45 /*
  46   Ugh, why static?
  47 */
  48 static Music *busy_ev;
  49 static Music *start_ev;
  50 static Music *melisma_playing_ev;
  51
  52 Lyric_combine_music_iterator::Lyric_combine_music_iterator ()
  53 {
  54   music_found_ = false;
  55   made_association_ = false;
  56   lyric_iter_ = 0;
  57   music_context_ = 0;
  58   lyrics_context_ = 0;
  59
  60   /*
  61     Ugh. out of place here.
  62   */
  63   if (!busy_ev)
  64     {
  65       busy_ev
  66         = make_music_by_name (ly_symbol2scm ("BusyPlayingEvent"));
  67       start_ev
  68         = make_music_by_name (ly_symbol2scm ("StartPlayingEvent"));
  69       melisma_playing_ev
  70         = make_music_by_name (ly_symbol2scm ("MelismaPlayingEvent"));
  71     }
  72 }
  73
  74 bool
  75 Lyric_combine_music_iterator::start_new_syllable ()
  76 {
  77   bool b = music_context_->try_music (busy_ev);
  78
  79   if (!b)
  80     return false;
  81
  82   if (!lyrics_context_)
  83     return false;
  84
  85   if (!to_boolean (lyrics_context_->get_property ("ignoreMelismata")))
  86     {
  87       bool m = music_context_->try_music (melisma_playing_ev);
  88       if (m)
  89         return false;
  90     }
  91
  92   return true;
  93 }
  94
  95 Moment
  96 Lyric_combine_music_iterator::pending_moment () const
  97 {
  98   Moment m;
  99
 100   m.set_infinite (1);
 101
 102   return m;
 103 }
 104
 105 bool
 106 Lyric_combine_music_iterator::run_always () const
 107 {
 108   return true;
 109 }
 110
 111 bool
 112 Lyric_combine_music_iterator::ok () const
 113 {
 114   return lyric_iter_ && lyric_iter_->ok ();
 115 }
 116
 117 void
 118 Lyric_combine_music_iterator::derived_mark ()const
 119 {
 120   if (lyric_iter_)
 121     scm_gc_mark (lyric_iter_->self_scm ());
 122   if (lyrics_context_)
 123     scm_gc_mark (lyrics_context_->self_scm ());
 124   if (music_context_)
 125     scm_gc_mark (music_context_->self_scm ());
 126 }
 127
 128 void
 129 Lyric_combine_music_iterator::derived_substitute (Context *f, Context *t)
 130 {
 131   if (lyric_iter_)
 132     lyric_iter_->substitute_outlet (f, t);
 133   if (lyrics_context_ && lyrics_context_ == f)
 134     lyrics_context_ = t;
 135   if (music_context_ && music_context_ == f)
 136     music_context_ = t;
 137 }
 138
 139 void
 140 Lyric_combine_music_iterator::construct_children ()
 141 {
 142   Music *m = unsmob_music (get_music ()->get_property ("element"));
 143   lyric_iter_ = unsmob_iterator (get_iterator (m));
 144
 145   lyricsto_voice_name_ = get_music ()->get_property ("associated-context");
 146
 147   find_voice ();
 148
 149   if (lyric_iter_)
 150     lyrics_context_ = find_context_below (lyric_iter_->get_outlet (),
 151                                           ly_symbol2scm ("Lyrics"), "");
 152
 153   /*
 154     We do not create a Lyrics context, because the user might
 155     create one with a different name, and then we will not find that
 156     one.
 157   */
 158 }
 159
 160 void
 161 Lyric_combine_music_iterator::find_voice ()
 162 {
 163   SCM voice_name = lyricsto_voice_name_;
 164   SCM running = lyrics_context_
 165     ? lyrics_context_->get_property ("associatedVoice")
 166     : SCM_EOL;
 167
 168   if (scm_is_string (running))
 169     voice_name = running;
 170
 171   if (scm_is_string (voice_name)
 172       && (!music_context_ || ly_scm2string (voice_name) != music_context_->id_string ()))
 173     {
 174       /*
 175         (spaghettini).
 176
 177         Need to set associatedVoiceContext again
 178       */
 179       if (music_context_)
 180         made_association_ = false;
 181
 182       Context *t = get_outlet ();
 183       while (t && t->get_parent_context ())
 184         t = t->get_parent_context ();
 185
 186       std::string name = ly_scm2string (voice_name);
 187       Context *voice = find_context_below (t, ly_symbol2scm ("Voice"), name);
 188
 189       if (voice)
 190         music_context_ = voice;
 191     }
 192
 193   if (lyrics_context_ && music_context_)
 194     {
 195       if (!made_association_)
 196         {
 197           made_association_ = true;
 198           lyrics_context_->set_property ("associatedVoiceContext",
 199                                          music_context_->self_scm ());
 200         }
 201     }
 202 }
 203
 204 void
 205 Lyric_combine_music_iterator::process (Moment)
 206 {
 207   find_voice ();
 208   if (!music_context_)
 209     return;
 210
 211   if (!music_context_->get_parent_context ())
 212     {
 213       /*
 214         The melody has died.
 215         We die too.
 216       */
 217       if (lyrics_context_)
 218         lyrics_context_->unset_property (ly_symbol2scm ("associatedVoiceContext"));
 219       lyric_iter_ = 0;
 220       music_context_ = 0;
 221     }
 222
 223   if (music_context_
 224       && start_new_syllable () && lyric_iter_->ok ())
 225     {
 226       Moment m = lyric_iter_->pending_moment ();
 227       lyric_iter_->process (m);
 228
 229       music_found_ = true;
 230     }
 231 }
 232
 233 void
 234 Lyric_combine_music_iterator::do_quit ()
 235 {
 236   if (!music_found_)
 237     {
 238       SCM voice_name = get_music ()->get_property ("associated-context");
 239
 240       std::string name;
 241       if (scm_is_string (voice_name))
 242         name = ly_scm2string (voice_name);
 243
 244       get_music ()->origin ()->warning (_f ("cannot find Voice `%s'",
 245                                             name.c_str ()) + "\n");
 246     }
 247
 248   if (lyric_iter_)
 249     lyric_iter_->quit ();
 250 }
 251
 252 Music_iterator *
 253 Lyric_combine_music_iterator::try_music_in_children (Music *m) const
 254 {
 255   return lyric_iter_->try_music (m);
 256 }
 257
 258 IMPLEMENT_CTOR_CALLBACK (Lyric_combine_music_iterator);