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

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