]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/lyric-combine-music-iterator.cc
Fix some bugs in the dynamic engraver and PostScript backend
[lilypond.git] / lily / lyric-combine-music-iterator.cc
index 6052b89ffd8e80577b71bfe46617d68e27449ea9..14d3959cee5ceaae5b0b461cb5d9a14f48653865 100644 (file)
-/*   
-  lyric-combine-music-iterator.cc --  implement Lyric_combine_music_iterator
-  
+/*
+  new-lyric-combine-iterator.cc -- implement Lyric_combine_music_iterator
+
   source file of the GNU LilyPond music typesetter
-  
-  (c) 1999--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-  
- */
 
-#include "translator-group.hh"
-#include "lyric-combine-music-iterator.hh"
-#include "lyric-combine-music.hh"
-#include "musical-request.hh"
+  (c) 2004--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+*/
 
-/*
-  Ugh, why static?
- */
-Busy_playing_req *busy_req;
-Melisma_req *melisma_start_req;
-Melisma_req *melisma_stop_req;
-Melisma_playing_req * melisma_playing_req;
+#include "context.hh"
+#include "dispatcher.hh"
+#include "global-context.hh"
+#include "grob.hh"
+#include "input.hh"
+#include "international.hh"
+#include "listener.hh"
+#include "music-iterator.hh"
+#include "music.hh"
+
+class Lyric_combine_music_iterator : public Music_iterator
+{
+public:
+  Lyric_combine_music_iterator ();
+  Lyric_combine_music_iterator (Lyric_combine_music_iterator const &src);
+  DECLARE_SCHEME_CALLBACK (constructor, ());
+protected:
+  virtual void construct_children ();
+  virtual Moment pending_moment () const;
+  virtual void do_quit ();
+  virtual void process (Moment);
+  virtual bool run_always ()const;
+  virtual bool ok () const;
+  virtual void derived_mark () const;
+  virtual void derived_substitute (Context *, Context *);
+  void set_music_context (Context *to);
+private:
+  bool start_new_syllable ();
+  Context *find_voice ();
+  DECLARE_LISTENER (set_busy);
+  DECLARE_LISTENER (check_new_context);
+
+  bool pending_grace_lyric_;
+  bool music_found_;
+  Context *lyrics_context_;
+  Context *music_context_;
+  SCM lyricsto_voice_name_;
+
+  bool busy_;
+  Music_iterator *lyric_iter_;
+};
 
 Lyric_combine_music_iterator::Lyric_combine_music_iterator ()
 {
-  if (!busy_req)
+  music_found_ = false;
+  pending_grace_lyric_ = false;
+  lyric_iter_ = 0;
+  music_context_ = 0;
+  lyrics_context_ = 0;
+  busy_ = false;
+}
+
+IMPLEMENT_LISTENER (Lyric_combine_music_iterator, set_busy)
+void
+Lyric_combine_music_iterator::set_busy (SCM se)
+{
+  Stream_event *e = unsmob_stream_event (se);
+  SCM mus = e->get_property ("music");
+  Music *m = unsmob_music (mus);
+  assert (m);
+
+  if (m->is_mus_type ("note-event") || m->is_mus_type ("cluster-note-event"))
+    busy_ = true;
+}
+
+void
+Lyric_combine_music_iterator::set_music_context (Context *to)
+{
+  if (music_context_)
+    {
+      music_context_->event_source()->remove_listener (GET_LISTENER (set_busy), ly_symbol2scm ("MusicEvent"));
+      lyrics_context_->unset_property (ly_symbol2scm ("associatedVoiceContext"));
+    }
+  music_context_ = to;
+  if (to)
+    {
+      to->event_source()->add_listener (GET_LISTENER (set_busy), ly_symbol2scm ("MusicEvent"));
+      lyrics_context_->set_property ("associatedVoiceContext", to->self_scm ());
+    }
+}
+
+bool
+Lyric_combine_music_iterator::start_new_syllable ()
+{
+  if (!busy_)
+    return false;
+
+  busy_ = false;
+
+  if (!lyrics_context_)
+    return false;
+
+  if (!to_boolean (lyrics_context_->get_property ("ignoreMelismata")))
     {
-      busy_req = new Busy_playing_req;
-      melisma_playing_req = new Melisma_playing_req;
-      melisma_stop_req = new Melisma_req;
-      melisma_start_req = new Melisma_req;      
+      bool m = melisma_busy (music_context_);
+      if (m)
+       return false;
     }
-  melisma_start_req->set_span_dir (START);
-  melisma_stop_req->set_span_dir (STOP);
-  
-  music_iter_p_ =0;
-  lyric_iter_p_ =0;
+
+  return true;
 }
 
 Moment
 Lyric_combine_music_iterator::pending_moment () const
 {
-  Moment musnext = music_iter_p_->pending_moment ();
-  return musnext;
+  Moment m;
+
+  m.set_infinite (1);
+
+  return m;
+}
+
+bool
+Lyric_combine_music_iterator::run_always () const
+{
+  return true;
 }
 
 bool
 Lyric_combine_music_iterator::ok () const
 {
-  return music_iter_p_->ok ();
+  return lyric_iter_ && lyric_iter_->ok ();
 }
 
+void
+Lyric_combine_music_iterator::derived_mark ()const
+{
+  if (lyric_iter_)
+    scm_gc_mark (lyric_iter_->self_scm ());
+  if (lyrics_context_)
+    scm_gc_mark (lyrics_context_->self_scm ());
+  if (music_context_)
+    scm_gc_mark (music_context_->self_scm ());
+}
 
 void
-Lyric_combine_music_iterator::construct_children ()
+Lyric_combine_music_iterator::derived_substitute (Context *f, Context *t)
 {
-  Lyric_combine_music const * m = dynamic_cast<Lyric_combine_music const*> (music_l ());
-  
-  music_iter_p_ = get_iterator_p (m->music_l ());
-  lyric_iter_p_ = get_iterator_p (m->lyrics_l ());
+  if (lyric_iter_)
+    lyric_iter_->substitute_outlet (f, t);
+  if (lyrics_context_ && lyrics_context_ == f)
+    lyrics_context_ = t;
+  if (music_context_ && music_context_ == f)
+    set_music_context (t);
 }
 
 void
-Lyric_combine_music_iterator::process (Moment m)
+Lyric_combine_music_iterator::construct_children ()
 {
-  Moment my_next = music_iter_p_->pending_moment ();
-  if (my_next > m)
+  Music *m = unsmob_music (get_music ()->get_property ("element"));
+  lyric_iter_ = unsmob_iterator (get_iterator (m));
+  if (!lyric_iter_)
     return;
-  
-  music_iter_p_->process (m);
+  lyrics_context_ = find_context_below (lyric_iter_->get_outlet (),
+                                       ly_symbol2scm ("Lyrics"), "");
+
+  lyricsto_voice_name_ = get_music ()->get_property ("associated-context");
 
-  bool busy = try_music (busy_req);
-  if (busy)
+  Context *voice = find_voice ();
+  if (voice)
+    set_music_context (voice);
+  else
     {
-      bool melisma_b = try_music (melisma_playing_req);
-      if (!melisma_b)
-       {
-         if (lyric_iter_p_->ok ())
-           {
-             // FIXME
-#if 0                          // devise a new way for this
-             if (melisma_b && !melisma_started_b_)
-               lyric_iter_p_->try_music (melisma_start_req);
-             else if (melisma_started_b_)
-               lyric_iter_p_->try_music (melisma_stop_req);
-#endif
-             
-             Moment m= lyric_iter_p_->pending_moment ();
-             lyric_iter_p_->process (m);
-           }
-       }
+      /*
+        Wait for a Create_context event. If this isn't done, lyrics can be 
+        delayed when voices are created implicitly.
+      */
+      Global_context *g = lyrics_context_->get_global_context ();
+      g->events_below ()->add_listener (GET_LISTENER (check_new_context), ly_symbol2scm ("CreateContext"));
     }
-  
+
+  /*
+    We do not create a Lyrics context, because the user might
+    create one with a different name, and then we will not find that
+    one.
+  */
 }
 
-Lyric_combine_music_iterator::~Lyric_combine_music_iterator ()
+IMPLEMENT_LISTENER (Lyric_combine_music_iterator, check_new_context)
+void
+Lyric_combine_music_iterator::check_new_context (SCM sev)
 {
-  delete lyric_iter_p_;
-  delete music_iter_p_;
+  // TODO: Check first if type=Voice and if id matches
+  (void)sev;
+
+  Context *voice = find_voice ();
+  if (voice)
+    {
+      set_music_context (voice);
+
+      Global_context *g = voice->get_global_context ();
+      g->events_below ()->remove_listener (GET_LISTENER (check_new_context), ly_symbol2scm ("CreateContext"));
+    }
 }
 
-Lyric_combine_music_iterator::Lyric_combine_music_iterator (Lyric_combine_music_iterator const & src)
-    : Music_iterator (src)
+/*
+Look for a suitable voice to align lyrics to.
+*/
+Context *
+Lyric_combine_music_iterator::find_voice ()
 {
+  SCM voice_name = lyricsto_voice_name_;
+  SCM running = lyrics_context_
+    ? lyrics_context_->get_property ("associatedVoice")
+    : SCM_EOL;
+
+  if (scm_is_string (running))
+    voice_name = running;
+
+  if (scm_is_string (voice_name)
+      && (!music_context_ || ly_scm2string (voice_name) != music_context_->id_string ()))
+    {
+      Context *t = get_outlet ();
+      while (t && t->get_parent_context ())
+       t = t->get_parent_context ();
 
-  lyric_iter_p_ = src.lyric_iter_p_ ? src.lyric_iter_p_->clone () : 0;
-  music_iter_p_ = src.music_iter_p_ ? src.music_iter_p_->clone () : 0;  
+      string name = ly_scm2string (voice_name);
+      return find_context_below (t, ly_symbol2scm ("Voice"), name);
+    }
+
+  return 0;
 }
-Music_iterator*
-Lyric_combine_music_iterator::try_music_in_children (Music *m) const
+
+void
+Lyric_combine_music_iterator::process (Moment)
 {
-  Music_iterator * i =  music_iter_p_->try_music (m);
-  if (i)
-    return i;
-  else
-    return lyric_iter_p_->try_music (m);
+  find_voice ();
+  if (!music_context_)
+    return;
+
+  if (!music_context_->get_parent_context ())
+    {
+      /*
+       The melody has died.
+       We die too.
+      */
+      if (lyrics_context_)
+       lyrics_context_->unset_property (ly_symbol2scm ("associatedVoiceContext"));
+      lyric_iter_ = 0;
+      set_music_context (0);
+    }
+
+  if (music_context_
+      && (start_new_syllable () || pending_grace_lyric_)
+      && lyric_iter_->ok ())
+    {
+      if (music_context_->now_mom ().grace_part_)
+       {
+         pending_grace_lyric_ = true;
+         return;
+       }
+      else
+       pending_grace_lyric_ = false;
+      
+      Moment m = lyric_iter_->pending_moment ();
+      lyric_iter_->process (m);
+
+      music_found_ = true;
+    }
 }
 
+void
+Lyric_combine_music_iterator::do_quit ()
+{
+  if (!music_found_)
+    {
+      SCM voice_name = get_music ()->get_property ("associated-context");
+
+      string name;
+      if (scm_is_string (voice_name))
+       name = ly_scm2string (voice_name);
+
+      get_music ()->origin ()->warning (_f ("cannot find Voice `%s'",
+                                           name.c_str ()) + "\n");
+    }
+
+  if (lyric_iter_)
+    lyric_iter_->quit ();
+}
 
 IMPLEMENT_CTOR_CALLBACK (Lyric_combine_music_iterator);