2 new-lyric-combine-iterator.cc -- implement Lyric_combine_music_iterator
4 source file of the GNU LilyPond music typesetter
6 (c) 2004--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
9 #include "dispatcher.hh"
10 #include "global-context.hh"
13 #include "international.hh"
14 #include "listener.hh"
15 #include "music-iterator.hh"
18 class Lyric_combine_music_iterator : public Music_iterator
21 Lyric_combine_music_iterator ();
22 Lyric_combine_music_iterator (Lyric_combine_music_iterator const &src);
23 DECLARE_SCHEME_CALLBACK (constructor, ());
25 virtual void construct_children ();
26 virtual Moment pending_moment () const;
27 virtual void do_quit ();
28 virtual void process (Moment);
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 void set_music_context (Context *to);
35 bool start_new_syllable ();
36 Context *find_voice ();
37 DECLARE_LISTENER (set_busy);
38 DECLARE_LISTENER (check_new_context);
40 bool pending_grace_lyric_;
42 Context *lyrics_context_;
43 Context *music_context_;
44 SCM lyricsto_voice_name_;
47 Music_iterator *lyric_iter_;
50 Lyric_combine_music_iterator::Lyric_combine_music_iterator ()
53 pending_grace_lyric_ = false;
60 IMPLEMENT_LISTENER (Lyric_combine_music_iterator, set_busy)
62 Lyric_combine_music_iterator::set_busy (SCM se)
64 Stream_event *e = unsmob_stream_event (se);
66 if (e->in_event_class ("note-event") || e->in_event_class ("cluster-note-event"))
71 Lyric_combine_music_iterator::set_music_context (Context *to)
75 music_context_->event_source()->remove_listener (GET_LISTENER (set_busy), ly_symbol2scm ("music-event"));
76 lyrics_context_->unset_property (ly_symbol2scm ("associatedVoiceContext"));
81 to->event_source()->add_listener (GET_LISTENER (set_busy), ly_symbol2scm ("music-event"));
82 lyrics_context_->set_property ("associatedVoiceContext", to->self_scm ());
87 Lyric_combine_music_iterator::start_new_syllable ()
97 if (!to_boolean (lyrics_context_->get_property ("ignoreMelismata")))
99 bool m = melisma_busy (music_context_);
108 Lyric_combine_music_iterator::pending_moment () const
118 Lyric_combine_music_iterator::run_always () const
124 Lyric_combine_music_iterator::ok () const
126 return lyric_iter_ && lyric_iter_->ok ();
130 Lyric_combine_music_iterator::derived_mark ()const
133 scm_gc_mark (lyric_iter_->self_scm ());
135 scm_gc_mark (lyrics_context_->self_scm ());
137 scm_gc_mark (music_context_->self_scm ());
141 Lyric_combine_music_iterator::derived_substitute (Context *f, Context *t)
144 lyric_iter_->substitute_outlet (f, t);
145 if (lyrics_context_ && lyrics_context_ == f)
147 if (music_context_ && music_context_ == f)
148 set_music_context (t);
152 Lyric_combine_music_iterator::construct_children ()
154 Music *m = unsmob_music (get_music ()->get_property ("element"));
155 lyric_iter_ = unsmob_iterator (get_iterator (m));
158 lyrics_context_ = find_context_below (lyric_iter_->get_outlet (),
159 ly_symbol2scm ("Lyrics"), "");
161 lyricsto_voice_name_ = get_music ()->get_property ("associated-context");
163 Context *voice = find_voice ();
165 set_music_context (voice);
169 Wait for a Create_context event. If this isn't done, lyrics can be
170 delayed when voices are created implicitly.
172 Global_context *g = lyrics_context_->get_global_context ();
173 g->events_below ()->add_listener (GET_LISTENER (check_new_context), ly_symbol2scm ("CreateContext"));
177 We do not create a Lyrics context, because the user might
178 create one with a different name, and then we will not find that
183 IMPLEMENT_LISTENER (Lyric_combine_music_iterator, check_new_context)
185 Lyric_combine_music_iterator::check_new_context (SCM sev)
187 // TODO: Check first if type=Voice and if id matches
190 Context *voice = find_voice ();
193 set_music_context (voice);
195 Global_context *g = voice->get_global_context ();
196 g->events_below ()->remove_listener (GET_LISTENER (check_new_context), ly_symbol2scm ("CreateContext"));
201 Look for a suitable voice to align lyrics to.
203 Returns 0 if nothing should change; i.e., if we already listen to the
204 right voice, or if we don't yet listen to a voice but no appropriate
205 voice could be found.
208 Lyric_combine_music_iterator::find_voice ()
210 SCM voice_name = lyricsto_voice_name_;
211 SCM running = lyrics_context_
212 ? lyrics_context_->get_property ("associatedVoice")
215 if (scm_is_string (running))
216 voice_name = running;
218 if (scm_is_string (voice_name)
219 && (!music_context_ || ly_scm2string (voice_name) != music_context_->id_string ()))
221 Context *t = get_outlet ();
222 while (t && t->get_parent_context ())
223 t = t->get_parent_context ();
225 string name = ly_scm2string (voice_name);
226 return find_context_below (t, ly_symbol2scm ("Voice"), name);
233 Lyric_combine_music_iterator::process (Moment)
235 /* see if associatedVoice has been changed */
236 Context *new_voice = find_voice ();
238 set_music_context (new_voice);
243 if (!music_context_->get_parent_context ())
250 lyrics_context_->unset_property (ly_symbol2scm ("associatedVoiceContext"));
252 set_music_context (0);
256 && (start_new_syllable () || pending_grace_lyric_)
257 && lyric_iter_->ok ())
259 if (music_context_->now_mom ().grace_part_)
261 pending_grace_lyric_ = true;
265 pending_grace_lyric_ = false;
267 Moment m = lyric_iter_->pending_moment ();
268 lyric_iter_->process (m);
275 Lyric_combine_music_iterator::do_quit ()
279 SCM voice_name = get_music ()->get_property ("associated-context");
282 if (scm_is_string (voice_name))
283 name = ly_scm2string (voice_name);
285 get_music ()->origin ()->warning (_f ("cannot find Voice `%s'",
286 name.c_str ()) + "\n");
290 lyric_iter_->quit ();
293 IMPLEMENT_CTOR_CALLBACK (Lyric_combine_music_iterator);