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 music_found_;
  38   bool made_association_;
  39   Context * lyrics_context_;
  40   Context * music_context_;
  41   Music_iterator * lyric_iter_;
  42 };
  43
  44 /*
  45   Ugh, why static?
  46  */
  47 static Music *busy_ev;
  48 static Music *start_ev;
  49 static Music *melisma_playing_ev;
  50
  51 New_lyric_combine_music_iterator::New_lyric_combine_music_iterator ()
  52 {
  53   music_found_ = false;
  54   made_association_ = false;
  55   lyric_iter_ =0;
  56   music_context_ =0;
  57   lyrics_context_ = 0;
  58
  59   /*
  60     Ugh. out of place here.
  61    */
  62   if (!busy_ev)
  63     {
  64       busy_ev
  65         = make_music_by_name (ly_symbol2scm ("BusyPlayingEvent"));
  66       start_ev
  67         = make_music_by_name (ly_symbol2scm ("StartPlayingEvent"));
  68       melisma_playing_ev
  69         = make_music_by_name (ly_symbol2scm ("MelismaPlayingEvent"));
  70     }
  71 }
  72
  73 bool
  74 New_lyric_combine_music_iterator::start_new_syllable ()
  75 {
  76   bool b = music_context_->try_music (busy_ev);
  77
  78   if (!b)
  79     return false;
  80
  81   if (!lyrics_context_)
  82     return false;
  83
  84   if (!to_boolean (lyrics_context_->get_property ("ignoreMelismata")))
  85     {
  86       bool m = music_context_->try_music (melisma_playing_ev);
  87       if (m)
  88         return false;
  89     }
  90
  91   return true;
  92 }
  93
  94 Moment
  95 New_lyric_combine_music_iterator::pending_moment () const
  96 {
  97   Moment m;
  98
  99   m.set_infinite (1);
 100
 101   return m;
 102 }
 103
 104 bool
 105 New_lyric_combine_music_iterator::run_always () const
 106 {
 107   return true;
 108 }
 109
 110 bool
 111 New_lyric_combine_music_iterator::ok () const
 112 {
 113   return lyric_iter_ && lyric_iter_->ok ();
 114 }
 115
 116 void
 117 New_lyric_combine_music_iterator::derived_mark ()const
 118 {
 119   if (lyric_iter_)
 120     scm_gc_mark (lyric_iter_->self_scm ());
 121   if (lyrics_context_)
 122     scm_gc_mark (lyrics_context_->self_scm ());
 123   if (music_context_)
 124     scm_gc_mark (music_context_->self_scm ());
 125 }
 126
 127 void
 128 New_lyric_combine_music_iterator::derived_substitute (Context *f, Context *t)
 129 {
 130   if (lyric_iter_)
 131     lyric_iter_->substitute_outlet (f,t);
 132   if (lyrics_context_ && lyrics_context_==f)
 133     lyrics_context_ = t;
 134   if (music_context_ && music_context_ == f)
 135     music_context_ = t;
 136 }
 137
 138
 139 void
 140 New_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   find_voice ();
 146
 147   if (lyric_iter_)
 148     lyrics_context_ = find_context_below (lyric_iter_->get_outlet (),
 149                                           ly_symbol2scm ("Lyrics"), "");
 150
 151   /*
 152     We do not create a Lyrics context, because the user might
 153     create one with a different name, and then we will not find that
 154     one.
 155    */
 156 }
 157
 158 void
 159 New_lyric_combine_music_iterator::find_voice ()
 160 {
 161   if (!music_context_)
 162     {
 163       SCM voice_name = get_music ()->get_property ("associated-context");
 164
 165       if (ly_c_string_p (voice_name))
 166         {
 167           Context *t = get_outlet ();
 168           while (t && t->get_parent_context ())
 169             t = t->get_parent_context ();
 170
 171           String name = ly_scm2string (voice_name);
 172           Context *voice = find_context_below (t, ly_symbol2scm ("Voice"), name);
 173           if (voice)
 174             music_context_ = voice;
 175
 176         }
 177     }
 178
 179   if (lyrics_context_ && music_context_)
 180     {
 181       if (!made_association_)
 182         {
 183           made_association_ = true;
 184           lyrics_context_->set_property ("associatedVoiceContext",
 185                                          music_context_->self_scm ());
 186         }
 187     }
 188 }
 189
 190 void
 191 New_lyric_combine_music_iterator::process (Moment )
 192 {
 193   find_voice ();
 194   if (!music_context_)
 195     return ;
 196
 197   if (!music_context_->get_parent_context ())
 198     {
 199       /*
 200         The melody has died.
 201         We die too.
 202        */
 203       if (lyrics_context_)
 204         lyrics_context_->unset_property (ly_symbol2scm ("associatedVoiceContext"));
 205       lyric_iter_ = 0;
 206       music_context_ = 0;
 207     }
 208
 209   if (music_context_
 210       && start_new_syllable () && lyric_iter_->ok ())
 211     {
 212       Moment m= lyric_iter_->pending_moment ();
 213       lyric_iter_->process (m);
 214
 215       music_found_ = true;
 216     }
 217 }
 218
 219 void
 220 New_lyric_combine_music_iterator::do_quit ()
 221 {
 222   if (!music_found_)
 223     {
 224       SCM voice_name = get_music ()->get_property ("associated-context");
 225
 226       String name;
 227       if (ly_c_string_p (voice_name))
 228         name = ly_scm2string (voice_name);
 229
 230       get_music ()->origin ()->warning (_f ("Haven't found Voice `%s'.",
 231                                             name.to_str0 ()) + "\n");
 232     }
 233
 234   if (lyric_iter_)
 235     lyric_iter_->quit ();
 236 }
 237
 238
 239
 240 Music_iterator*
 241 New_lyric_combine_music_iterator::try_music_in_children (Music *m) const
 242 {
 243   return lyric_iter_->try_music (m);
 244 }
 245
 246
 247 IMPLEMENT_CTOR_CALLBACK (New_lyric_combine_music_iterator);